parser

Documentation

Index

• func Parse(name string, r io.Reader) (*types.Codelab, error)
• func ParseFragment(name string, r io.Reader) ([]types.Node, error)
• func Parsers() []string
• func Register(name string, p Parser)
• type Parser

Functions

func Parse

func Parse(name string, r io.Reader) (*types.Codelab, error)

Parse parses source r into a Codelab using a parser registered with the specified name.

func ParseFragment

func ParseFragment(name string, r io.Reader) ([]types.Node, error)

ParseFragment parses a codelab fragment provided in r, using a parser registered with the specified name.

func Parsers

func Parsers() []string

Parsers returns a slice of all registered parser names.

func Register

func Register(name string, p Parser)

Register registers a new parser f under specified name. It panics if another parser is already registered under the same name.

Types

type Parser

type Parser interface {
	// Parse parses source r into a Codelab for the specified environment env.
	Parse(r io.Reader) (*types.Codelab, error)

	// ParseFragment is similar to Parse except it doesn't parse codelab metadata.
	ParseFragment(r io.Reader) ([]types.Node, error)
}

Parser parses a codelab in specific resource format. Each parser needs to call Register to become a known parser.