ref

Documentation

Overview

Package ref provides the general-purpose ability to mark a document as targeted for specific library.

Index

• Constants
• type LibraryRef
  • func (p LibraryRef) AsString() string
  • func (p LibraryRef) Matches(lpp LibraryRef) bool
• type LibraryRefExtractor
  • func (n LibraryRefExtractor) FromAnnotation(anns template.NodeAnnotations) ([]LibraryRef, error)
  • func (n LibraryRefExtractor) FromStr(libRefStr string) ([]LibraryRef, error)

Constants

const (
	AnnotationLibraryRef = "library/ref"

	LibrarySep = "@"
)

Types

type LibraryRef

type LibraryRef struct {
	Path  string
	Alias string
}

func (LibraryRef) AsString

func (p LibraryRef) AsString() string

func (LibraryRef) Matches

func (p LibraryRef) Matches(lpp LibraryRef) bool

type LibraryRefExtractor

type LibraryRefExtractor struct {
}

func (LibraryRefExtractor) FromAnnotation

func (n LibraryRefExtractor) FromAnnotation(anns template.NodeAnnotations) ([]LibraryRef, error)

func (LibraryRefExtractor) FromStr

func (n LibraryRefExtractor) FromStr(libRefStr string) ([]LibraryRef, error)