README
¶
Package cloudeng.io/cmdutil/cmdyaml
import cloudeng.io/cmdutil/cmdyaml
Functions
Func ErrorWithSource
func ErrorWithSource(spec []byte, err error) error
ErrorWithSource returns an error that includes the yaml source code that was the cause of the error to help with debugging YAML errors. Note that the errors reported for the yaml parser may be inaccurate in terms of the lines the error is reported on. This seems to be particularly true for lists where errors with use of tabs to indent are often reported against the previous line rather than the offending one.
Func ParseConfig
func ParseConfig(spec []byte, cfg interface{}) error
ParseConfig will parse the yaml config in spec into the requested type. It provides improved error reporting via ErrorWithSource.
Func ParseConfigFile
func ParseConfigFile(ctx context.Context, filename string, cfg interface{}) error
ParseConfigFile reads a yaml config file as per ParseConfig using file.FSReadFile to read the file. The use of FSReadFile allows for the configuration file to be read from storage system, including from embed.FS, instead of the local filesystem if an instance of fs.ReadFileFS is stored in the context.
Func ParseConfigString
func ParseConfigString(spec string, cfg interface{}) error
ParseConfigString is like ParseConfig but for a string.
Func ParseConfigURI
func ParseConfigURI(ctx context.Context, filename string, cfg interface{}, handlers map[string]URLHandler) error
ParseConfigURI is like ParseConfigFile but for a URI.
Func WithFSForURI
func WithFSForURI(ctx context.Context, uri string, handlers map[string]URLHandler) (context.Context, string)
WithFSForURI will parse the supplied URI and if it has a scheme that matches one of the handlers, will call the handler to create a new context and pathname. If no handler is found, the original context and URI are returned.
Types
Type FlexTime
type FlexTime time.Time
FlexTime is a time.Time that can be unmarshaled from time.RFC3339, time.DateTime, time.TimeOnly or time.DateOnly formats. It is always marshaled to time.RFC3339.
Methods
func (t *FlexTime) MarshalYAML() (interface{}, error)
func (t FlexTime) String() string
func (t *FlexTime) UnmarshalYAML(value *yaml.Node) error
Type RFC3339Time
type RFC3339Time time.Time
RFC3339Time is a time.Time that marshals to and from RFC3339 format.
Methods
func (t *RFC3339Time) MarshalYAML() (interface{}, error)
func (t RFC3339Time) String() string
func (t *RFC3339Time) UnmarshalYAML(value *yaml.Node) error
Type URLHandler
type URLHandler func(context.Context, *url.URL) (ctx context.Context, pathname string)
URLHandler is a function that uses the supplied URL to create a new context containing an fs.ReadFileFS instance that can be used to read the contents of the original URL using the returned pathname.
Documentation
¶
Index ¶
- func ErrorWithSource(spec []byte, err error) error
- func ParseConfig(spec []byte, cfg interface{}) error
- func ParseConfigFile(ctx context.Context, filename string, cfg interface{}) error
- func ParseConfigString(spec string, cfg interface{}) error
- func ParseConfigURI(ctx context.Context, filename string, cfg interface{}, ...) error
- func WithFSForURI(ctx context.Context, uri string, handlers map[string]URLHandler) (context.Context, string)
- type FlexTime
- type RFC3339Time
- type URLHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ErrorWithSource ¶
ErrorWithSource returns an error that includes the yaml source code that was the cause of the error to help with debugging YAML errors. Note that the errors reported for the yaml parser may be inaccurate in terms of the lines the error is reported on. This seems to be particularly true for lists where errors with use of tabs to indent are often reported against the previous line rather than the offending one.
func ParseConfig ¶
ParseConfig will parse the yaml config in spec into the requested type. It provides improved error reporting via ErrorWithSource.
func ParseConfigFile ¶
ParseConfigFile reads a yaml config file as per ParseConfig using file.FSReadFile to read the file. The use of FSReadFile allows for the configuration file to be read from storage system, including from embed.FS, instead of the local filesystem if an instance of fs.ReadFileFS is stored in the context.
func ParseConfigString ¶
ParseConfigString is like ParseConfig but for a string.
func ParseConfigURI ¶
func ParseConfigURI(ctx context.Context, filename string, cfg interface{}, handlers map[string]URLHandler) error
ParseConfigURI is like ParseConfigFile but for a URI.
func WithFSForURI ¶
func WithFSForURI(ctx context.Context, uri string, handlers map[string]URLHandler) (context.Context, string)
WithFSForURI will parse the supplied URI and if it has a scheme that matches one of the handlers, will call the handler to create a new context and pathname. If no handler is found, the original context and URI are returned.
Types ¶
type FlexTime ¶
FlexTime is a time.Time that can be unmarshaled from time.RFC3339, time.DateTime, time.TimeOnly or time.DateOnly formats. It is always marshaled to time.RFC3339.
func (*FlexTime) MarshalYAML ¶
func (*FlexTime) UnmarshalYAML ¶
type RFC3339Time ¶
RFC3339Time is a time.Time that marshals to and from RFC3339 format.
func (*RFC3339Time) MarshalYAML ¶
func (t *RFC3339Time) MarshalYAML() (interface{}, error)
func (RFC3339Time) String ¶
func (t RFC3339Time) String() string
func (*RFC3339Time) UnmarshalYAML ¶
func (t *RFC3339Time) UnmarshalYAML(value *yaml.Node) error
type URLHandler ¶
URLHandler is a function that uses the supplied URL to create a new context containing an fs.ReadFileFS instance that can be used to read the contents of the original URL using the returned pathname.
Source Files