caddy: github.com/caddyserver/caddy/caddyfile Index | Files

package caddyfile

import "github.com/caddyserver/caddy/caddyfile"

Index

Package Files

dispenser.go json.go lexer.go parse.go

func FromJSON Uses

func FromJSON(jsonBytes []byte) ([]byte, error)

FromJSON converts JSON-encoded jsonBytes to Caddyfile text

func ToJSON Uses

func ToJSON(caddyfile []byte) ([]byte, error)

ToJSON converts caddyfile to its JSON representation.

type Dispenser Uses

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 Uses

func NewDispenser(filename string, input io.Reader) Dispenser

NewDispenser returns a Dispenser, ready to use for parsing the given input.

func NewDispenserTokens Uses

func NewDispenserTokens(filename string, tokens []Token) Dispenser

NewDispenserTokens returns a Dispenser filled with the given tokens.

func (*Dispenser) ArgErr Uses

func (d *Dispenser) ArgErr() error

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 Uses

func (d *Dispenser) Args(targets ...*string) bool

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 Uses

func (d *Dispenser) EOFErr() error

EOFErr returns an error indicating that the dispenser reached the end of the input when searching for the next token.

func (*Dispenser) Err Uses

func (d *Dispenser) Err(msg string) error

Err generates a custom parse-time error with a message of msg.

func (*Dispenser) Errf Uses

func (d *Dispenser) Errf(format string, args ...interface{}) error

Errf is like Err, but for formatted error messages

func (*Dispenser) File Uses

func (d *Dispenser) File() string

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 Uses

func (d *Dispenser) Line() int

Line gets the line number of the current token. If there is no token loaded, it returns 0.

func (*Dispenser) Next Uses

func (d *Dispenser) Next() bool

Next loads the next token. Returns true if a token was loaded; false otherwise. If false, all tokens have been consumed.

func (*Dispenser) NextArg Uses

func (d *Dispenser) NextArg() bool

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 Uses

func (d *Dispenser) NextBlock() bool

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 Uses

func (d *Dispenser) NextLine() bool

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 Uses

func (d *Dispenser) RemainingArgs() []string

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.

func (*Dispenser) SyntaxErr Uses

func (d *Dispenser) SyntaxErr(expected string) error

SyntaxErr creates a generic syntax error which explains what was found and what was expected.

func (*Dispenser) Val Uses

func (d *Dispenser) Val() string

Val gets the text of the current token. If there is no token loaded, it returns empty string.

type EncodedCaddyfile Uses

type EncodedCaddyfile []EncodedServerBlock

EncodedCaddyfile encapsulates a slice of EncodedServerBlocks.

type EncodedServerBlock Uses

type EncodedServerBlock struct {
    Keys []string        `json:"keys"`
    Body [][]interface{} `json:"body"`
}

EncodedServerBlock represents a server block ripe for encoding.

type ServerBlock Uses

type ServerBlock struct {
    Keys   []string
    Tokens map[string][]Token
}

ServerBlock associates any number of keys (usually addresses of some sort) with tokens (grouped by directive name).

func Parse Uses

func Parse(filename string, input io.Reader, validDirectives []string) ([]ServerBlock, error)

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.

type Token Uses

type Token struct {
    File string
    Line int
    Text string
}

Token represents a single parsable unit.

Package caddyfile imports 13 packages (graph) and is imported by 40 packages. Updated 2019-07-02. Refresh now. Tools for package owners.