fluent

Documentation

Index

• func DefaultFileDecoderProvider(file string) dom.DecoderFunc
• func DefaultFileEncoderProvider(file string) dom.EncoderFunc
• func MustTransform[T any](in any, codec dom.FormatBiCodec) *T
• func MustTransformSlice[F any, T any](in []F, codec dom.FormatBiCodec) []*T
• func Transcode[T any](in *T, enc dom.EncoderFunc, dec dom.DecoderFunc, outEnc dom.EncoderFunc, ...) error
• func TranscodeJson2Yaml[T any](in *T, w io.Writer) error
• func TranscodeWithCodec[T any](in *T, codec dom.FormatBiCodec, enc dom.EncoderFunc, w io.Writer) error
• func Transform[T any](in any, codec dom.FormatBiCodec) (*T, error)
• func TransformSlice[F any, T any](in []F, codec dom.FormatBiCodec) ([]*T, error)
• type ConfigHelper
  • func NewConfigHelper[T any](opts ...Opt[T]) ConfigHelper[T]
• type CopyMode
  • func CopyModeMerge(param ...CopyParam) CopyMode
  • func CopyModeReplace(param ...CopyParam) CopyMode
• type CopyParam
  • func CopyParamFilterFunc(fn dom.NodeVisitorFn) CopyParam
  • func CopyParamMergeOptions(mOpts ...dom.MergeOption) CopyParam
• type FileDecoderProvider
• type Morpher
  • func NewMorpher() Morpher
• type Opt
  • func WithCodec[T any](codec dom.FormatBiCodec) Opt[T]
  • func WithInitialData[T any](data dom.ContainerBuilder) Opt[T]

Functions

func DefaultFileDecoderProvider

func DefaultFileDecoderProvider(file string) dom.DecoderFunc

DefaultFileDecoderProvider is FileDecoderProvider that uses file suffix to choose dom.DecoderFunc

func DefaultFileEncoderProvider

func DefaultFileEncoderProvider(file string) dom.EncoderFunc

DefaultFileEncoderProvider is FileEncoderProvider that uses file suffix to choose dom.EncoderFunc

func MustTransform

func MustTransform[T any](in any, codec dom.FormatBiCodec) *T

func MustTransformSlice

func MustTransformSlice[F any, T any](in []F, codec dom.FormatBiCodec) []*T

func Transcode

func Transcode[T any](in *T, enc dom.EncoderFunc, dec dom.DecoderFunc, outEnc dom.EncoderFunc, w io.Writer) error

Transcode type into one serialized form then to another. Common use case for this code is when you have a type that has JSON tags with custom serialized names, no YAML tags. When you serialize such object directly into YAML, custom field names are lost.

func TranscodeJson2Yaml

func TranscodeJson2Yaml[T any](in *T, w io.Writer) error

TranscodeJson2Yaml takes T and encodes it into JSON form, then decodes it into intermediate object which is then serialized into YAML form.

func TranscodeWithCodec

func TranscodeWithCodec[T any](in *T, codec dom.FormatBiCodec, enc dom.EncoderFunc, w io.Writer) error

func Transform

func Transform[T any](in any, codec dom.FormatBiCodec) (*T, error)

Transform can transform arbitrary object to specific type, using provided codec. Common use case is to transform i.e. []interface{} to []MyType

func TransformSlice

func TransformSlice[F any, T any](in []F, codec dom.FormatBiCodec) ([]*T, error)

Types

type ConfigHelper

type ConfigHelper[T any] interface {
	// Add adds any object.
	Add(doc any) ConfigHelper[T]
	// Read reads given io.Reader and process it into T using configured codec
	Read(reader io.Reader) ConfigHelper[T]
	// Load loads given file and merge it into current object
	Load(file string) ConfigHelper[T]
	// Save saves current object into file
	Save(file string) ConfigHelper[T]
	// Mutate performs inline operations on current object
	Mutate(fn func(builder dom.ContainerBuilder)) ConfigHelper[T]
	// Result Get current object
	Result() *T
}

ConfigHelper allows to load, mutate and save configuration object

func NewConfigHelper

func NewConfigHelper[T any](opts ...Opt[T]) ConfigHelper[T]

type CopyMode

type CopyMode func(*copier)

func CopyModeMerge

func CopyModeMerge(param ...CopyParam) CopyMode

func CopyModeReplace

func CopyModeReplace(param ...CopyParam) CopyMode

CopyModeReplace Copies source container and removes anything that existed

type CopyParam

type CopyParam func(*copier)

func CopyParamFilterFunc

func CopyParamFilterFunc(fn dom.NodeVisitorFn) CopyParam

func CopyParamMergeOptions

func CopyParamMergeOptions(mOpts ...dom.MergeOption) CopyParam

type FileDecoderProvider

type FileDecoderProvider func(file string) dom.DecoderFunc

FileDecoderProvider resolves dom.DecoderFunc for given file. If file is not recognized, nil is returned.

type Morpher

type Morpher interface {
	// Mutate invokes provided callback to modify dom.Container
	Mutate(func(dom.ContainerBuilder)) Morpher

	// Copy copies content of src dom.Container into Morpher.
	Copy(src dom.Container, mode CopyMode) Morpher

	// Result gets a fresh copy of result. Subsequent invocation of this method will always produce a new copy.
	Result() dom.ContainerBuilder
}

Morpher allows fluent modification of document(s)

func NewMorpher

func NewMorpher() Morpher

type Opt

type Opt[T any] func(helper *configHelper[T])

func WithCodec

func WithCodec[T any](codec dom.FormatBiCodec) Opt[T]

func WithInitialData

func WithInitialData[T any](data dom.ContainerBuilder) Opt[T]