Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

yqlib

package

Go to main page

Versions in this module

v4

v4.35.221

Nov 29, 2023

v4.35.211

Nov 29, 2023

v4.35.210

Nov 29, 2023

v4.35.201

Oct 19, 2023

v4.35.200

Oct 19, 2023

Changes in this version

+ const Base64InputFormat

+ const Base64OutputFormat

+ const CSVObjectInputFormat

+ const CSVOutputFormat

+ const JSONOutputFormat

+ const JsonInputFormat

+ const LuaInputFormat

+ const LuaOutputFormat

+ const PropertiesInputFormat

+ const PropsOutputFormat

+ const ShOutputFormat

+ const ShellVariablesOutputFormat

+ const TSVObjectInputFormat

+ const TSVOutputFormat

+ const TomlInputFormat

+ const TomlOutputFormat

+ const UriInputFormat

+ const UriOutputFormat

+ const XMLInputFormat

+ const XMLOutputFormat

+ const YamlInputFormat

+ const YamlOutputFormat

+ var ConfiguredLuaPreferences = NewDefaultLuaPreferences()

+ var ConfiguredXMLPreferences = NewDefaultXmlPreferences()

+ var ConfiguredYamlPreferences = NewDefaultYamlPreferences()

+ var LoadYamlPreferences = YamlPreferences

+ var Now = time.Now

+ var PrettyPrintExp = `(... | (select(tag != "!!str"), select(tag == "!!str") | select(test("(?i)^(y|yes|n|no|on|off)$") | not)) ) style=""`

+ func FormatFromFilename(filename string) string

+ func GetLogger() *logging.Logger

+ func InitExpressionParser()

+ func KindString(kind Kind) string

+ func MapToYamlStyle(original Style) yaml.Style

+ func NewFrontMatterHandler(originalFilename string) frontMatterHandler

+ func NewWriteInPlaceHandler(inputFile string) writeInPlaceHandler

+ func NodeContentToString(node *CandidateNode, depth int) string

+ func NodeToString(node *CandidateNode) string

+ func NodesToString(collection *list.List) string

+ func SafelyCloseReader(reader io.Reader)

+ type CandidateNode struct

+ Alias *CandidateNode

+ Anchor string

+ Column int

+ Content []*CandidateNode

+ EvaluateTogether bool

+ FootComment string

+ HeadComment string

+ IsMapKey bool

+ Key *CandidateNode

+ Kind Kind

+ LeadingContent string

+ Line int

+ LineComment string

+ Parent *CandidateNode

+ Style Style

+ Tag string

+ Value string

+ func (n *CandidateNode) AddChild(rawChild *CandidateNode)

+ func (n *CandidateNode) AddChildren(children []*CandidateNode)

+ func (n *CandidateNode) AddKeyValueChild(rawKey *CandidateNode, rawValue *CandidateNode) (*CandidateNode, *CandidateNode)

+ func (n *CandidateNode) AsList() *list.List

+ func (n *CandidateNode) Copy() *CandidateNode

+ func (n *CandidateNode) CopyAsReplacement(replacement *CandidateNode) *CandidateNode

+ func (n *CandidateNode) CopyWithoutContent() *CandidateNode

+ func (n *CandidateNode) CreateChild() *CandidateNode

+ func (n *CandidateNode) CreateReplacement(kind Kind, tag string, value string) *CandidateNode

+ func (n *CandidateNode) CreateReplacementWithComments(kind Kind, tag string, style Style) *CandidateNode

+ func (n *CandidateNode) GetDocument() uint

+ func (n *CandidateNode) GetFileIndex() int

+ func (n *CandidateNode) GetFilename() string

+ func (n *CandidateNode) GetKey() string

+ func (n *CandidateNode) GetNicePath() string

+ func (n *CandidateNode) GetPath() []interface{}

+ func (n *CandidateNode) GetValueRep() (interface{}, error)

+ func (n *CandidateNode) SetDocument(idx uint)

+ func (n *CandidateNode) SetFileIndex(idx int)

+ func (n *CandidateNode) SetFilename(name string)

+ func (n *CandidateNode) SetParent(parent *CandidateNode)

+ func (n *CandidateNode) UpdateAttributesFrom(other *CandidateNode, prefs assignPreferences)

+ func (n *CandidateNode) UpdateFrom(other *CandidateNode, prefs assignPreferences)

+ func (o *CandidateNode) MarshalJSON() ([]byte, error)

+ func (o *CandidateNode) MarshalYAML() (*yaml.Node, error)

+ func (o *CandidateNode) UnmarshalGoccyYAML(node ast.Node, cm yaml.CommentMap) error

+ func (o *CandidateNode) UnmarshalJSON(data []byte) error

+ func (o *CandidateNode) UnmarshalYAML(node *yaml.Node, anchorMap map[string]*CandidateNode) error

+ type Context struct

+ DontAutoCreate bool

+ MatchingNodes *list.List

+ Variables map[string]*list.List

+ func (n *Context) ChildContext(results *list.List) Context

+ func (n *Context) Clone() Context

+ func (n *Context) DeepClone() Context

+ func (n *Context) GetDateTimeLayout() string

+ func (n *Context) GetVariable(name string) *list.List

+ func (n *Context) ReadOnlyClone() Context

+ func (n *Context) SetDateTimeLayout(newDateTimeLayout string)

+ func (n *Context) SetVariable(name string, value *list.List)

+ func (n *Context) SingleChildContext(candidate *CandidateNode) Context

+ func (n *Context) SingleReadonlyChildContext(candidate *CandidateNode) Context

+ func (n *Context) ToString() string

+ func (n *Context) WritableClone() Context

+ type DataTreeNavigator interface

+ DeeplyAssign func(context Context, path []interface{}, rhsNode *CandidateNode) error

+ GetMatchingNodes func(context Context, expressionNode *ExpressionNode) (Context, error)

+ func NewDataTreeNavigator() DataTreeNavigator

+ type Decoder interface

+ Decode func() (*CandidateNode, error)

+ Init func(reader io.Reader) error

+ func NewBase64Decoder() Decoder

+ func NewCSVObjectDecoder(separator rune) Decoder

+ func NewGoccyYAMLDecoder() Decoder

+ func NewJSONDecoder() Decoder

+ func NewLuaDecoder(prefs LuaPreferences) Decoder

+ func NewPropertiesDecoder() Decoder

+ func NewTomlDecoder() Decoder

+ func NewUriDecoder() Decoder

+ func NewXMLDecoder(prefs XmlPreferences) Decoder

+ func NewYamlDecoder(prefs YamlPreferences) Decoder

+ type Encoder interface

+ CanHandleAliases func() bool

+ Encode func(writer io.Writer, node *CandidateNode) error

+ PrintDocumentSeparator func(writer io.Writer) error

+ PrintLeadingContent func(writer io.Writer, content string) error

+ func NewBase64Encoder() Encoder

+ func NewCsvEncoder(separator rune) Encoder

+ func NewJSONEncoder(indent int, colorise bool, unwrapScalar bool) Encoder

+ func NewLuaEncoder(prefs LuaPreferences) Encoder

+ func NewPropertiesEncoder(unwrapScalar bool) Encoder

+ func NewShEncoder() Encoder

+ func NewShellVariablesEncoder() Encoder

+ func NewTomlEncoder() Encoder

+ func NewUriEncoder() Encoder

+ func NewXMLEncoder(indent int, prefs XmlPreferences) Encoder

+ func NewYamlEncoder(indent int, colorise bool, prefs YamlPreferences) Encoder

+ type Evaluator interface

+ EvaluateCandidateNodes func(expression string, inputCandidateNodes *list.List) (*list.List, error)

+ EvaluateFiles func(expression string, filenames []string, printer Printer, decoder Decoder, ...) error

+ EvaluateNodes func(expression string, nodes ...*yaml.Node) (*list.List, error)

+ func NewAllAtOnceEvaluator() Evaluator

+ type ExpressionNode struct

+ LHS *ExpressionNode

+ Operation *Operation

+ RHS *ExpressionNode

+ type ExpressionParserInterface interface

+ ParseExpression func(expression string) (*ExpressionNode, error)

+ var ExpressionParser ExpressionParserInterface

+ type InputFormat uint

+ func InputFormatFromString(format string) (InputFormat, error)

+ type Kind uint32

+ const AliasNode

+ const MappingNode

+ const ScalarNode

+ const SequenceNode

+ type LuaPreferences struct

+ DocPrefix string

+ DocSuffix string

+ Globals bool

+ UnquotedKeys bool

+ func NewDefaultLuaPreferences() LuaPreferences

+ type Operation struct

+ CandidateNode *CandidateNode

+ OperationType *operationType

+ Preferences interface{}

+ StringValue string

+ UpdateAssign bool

+ Value interface{}

+ type Printer interface

+ PrintResults func(matchingNodes *list.List) error

+ PrintedAnything func() bool

+ SetAppendix func(reader io.Reader)

+ SetNulSepOutput func(nulSepOutput bool)

+ func NewPrinter(encoder Encoder, printerWriter PrinterWriter) Printer

+ type PrinterOutputFormat uint32

+ func OutputFormatFromString(format string) (PrinterOutputFormat, error)

+ type PrinterWriter interface

+ GetWriter func(node *CandidateNode) (*bufio.Writer, error)

+ func NewMultiPrinterWriter(expression *ExpressionNode, format PrinterOutputFormat) PrinterWriter

+ func NewSinglePrinterWriter(writer io.Writer) PrinterWriter

+ type StreamEvaluator interface

+ Evaluate func(filename string, reader io.Reader, node *ExpressionNode, printer Printer, ...) (uint, error)

+ EvaluateFiles func(expression string, filenames []string, printer Printer, decoder Decoder, ...) error

+ EvaluateNew func(expression string, printer Printer) error

+ func NewStreamEvaluator() StreamEvaluator

+ type StringEvaluator interface

+ Evaluate func(expression string, input string, encoder Encoder, decoder Decoder) (string, error)

+ func NewStringEvaluator() StringEvaluator

+ type Style uint32

+ const DoubleQuotedStyle

+ const FlowStyle

+ const FoldedStyle

+ const LiteralStyle

+ const SingleQuotedStyle

+ const TaggedStyle

+ func MapYamlStyle(original yaml.Style) Style

+ type XmlPreferences struct

+ AttributePrefix string

+ ContentName string

+ DirectiveName string

+ KeepNamespace bool

+ ProcInstPrefix string

+ SkipDirectives bool

+ SkipProcInst bool

+ StrictMode bool

+ UseRawToken bool

+ func NewDefaultXmlPreferences() XmlPreferences

+ type YamlPreferences struct

+ EvaluateTogether bool

+ LeadingContentPreProcessing bool

+ PrintDocSeparators bool

+ UnwrapScalar bool

+ func NewDefaultYamlPreferences() YamlPreferences