Documentation
¶
Index ¶
- func FromJSON(jsonBytes []byte) ([]byte, error)
- func MustLoad(filePath string, configPtr interface{})
- func ToJSON(caddyfile []byte) ([]byte, error)
- type Dispenser
- func (d *Dispenser) ArgErr() error
- func (d *Dispenser) Args(targets ...*string) bool
- func (d *Dispenser) EOFErr() error
- func (d *Dispenser) Err(msg string) error
- func (d *Dispenser) Errf(format string, args ...interface{}) error
- func (d *Dispenser) File() string
- func (d *Dispenser) Line() int
- func (d *Dispenser) Next() bool
- func (d *Dispenser) NextArg() bool
- func (d *Dispenser) NextBlock() bool
- func (d *Dispenser) NextLine() bool
- func (d *Dispenser) RemainingArgs() []string
- func (d *Dispenser) SyntaxErr(expected string) error
- func (d *Dispenser) Val() string
- type EncodedCaddyfile
- type EncodedServerBlock
- type ServerBlock
- type Token
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Dispenser ¶ added in v1.0.6
type Dispenser struct {
// contains filtered or unexported fields
}
Dispenser is a type that dispenses tokens, similarly to a lexer, except that it can do so with some notion of structure and has some really convenient methods.
func NewDispenser ¶ added in v1.0.6
NewDispenser returns a Dispenser, ready to use for parsing the given input.
func NewDispenserTokens ¶ added in v1.0.6
NewDispenserTokens returns a Dispenser filled with the given tokens.
func (*Dispenser) ArgErr ¶ added in v1.0.6
ArgErr returns an argument error, meaning that another argument was expected but not found. In other words, a line break or open curly brace was encountered instead of an argument.
func (*Dispenser) Args ¶ added in v1.0.6
Args is a convenience function that loads the next arguments (tokens on the same line) into an arbitrary number of strings pointed to in targets. If there are fewer tokens available than string pointers, the remaining strings will not be changed and false will be returned. If there were enough tokens available to fill the arguments, then true will be returned.
func (*Dispenser) EOFErr ¶ added in v1.0.6
EOFErr returns an error indicating that the dispenser reached the end of the input when searching for the next token.
func (*Dispenser) Err ¶ added in v1.0.6
Err generates a custom parse-time error with a message of msg.
func (*Dispenser) File ¶ added in v1.0.6
File gets the filename of the current token. If there is no token loaded, it returns the filename originally given when parsing started.
func (*Dispenser) Line ¶ added in v1.0.6
Line gets the line number of the current token. If there is no token loaded, it returns 0.
func (*Dispenser) Next ¶ added in v1.0.6
Next loads the next token. Returns true if a token was loaded; false otherwise. If false, all tokens have been consumed.
func (*Dispenser) NextArg ¶ added in v1.0.6
NextArg loads the next token if it is on the same line. Returns true if a token was loaded; false otherwise. If false, all tokens on the line have been consumed. It handles imported tokens correctly.
func (*Dispenser) NextBlock ¶ added in v1.0.6
NextBlock can be used as the condition of a for loop to load the next token as long as it opens a block or is already in a block. It returns true if a token was loaded, or false when the block's closing curly brace was loaded and thus the block ended. Nested blocks are not supported.
func (*Dispenser) NextLine ¶ added in v1.0.6
NextLine loads the next token only if it is not on the same line as the current token, and returns true if a token was loaded; false otherwise. If false, there is not another token or it is on the same line. It handles imported tokens correctly.
func (*Dispenser) RemainingArgs ¶ added in v1.0.6
RemainingArgs loads any more arguments (tokens on the same line) into a slice and returns them. Open curly brace tokens also indicate the end of arguments, and the curly brace is not included in the return value nor is it loaded.
type EncodedCaddyfile ¶ added in v1.0.6
type EncodedCaddyfile []EncodedServerBlock
EncodedCaddyfile encapsulates a slice of EncodedServerBlocks.
type EncodedServerBlock ¶ added in v1.0.6
type EncodedServerBlock struct {
Keys []string `json:"keys"`
Body [][]interface{} `json:"body"`
}
EncodedServerBlock represents a server block ripe for encoding.
type ServerBlock ¶ added in v1.0.6
ServerBlock associates any number of keys (usually addresses of some sort) with tokens (grouped by directive name).
func Parse ¶ added in v1.0.6
Parse parses the input just enough to group tokens, in order, by server block. No further parsing is performed. Server blocks are returned in the order in which they appear. Directives that do not appear in validDirectives will cause an error. If you do not want to check for valid directives, pass in nil instead.
Source Files