Options

public struct Options

Configuration options to use when emitting YAML.

Show on GitHub

canonical
Set if the output should be in the “canonical” format described in the YAML specification.
Declaration
Swift

public var canonical: Bool
Show on GitHub
indent
Set the indentation value.
Declaration
Swift

public var indent: Int
Show on GitHub
width
Set the preferred line width. -1 means unlimited.
Declaration
Swift

public var width: Int
Show on GitHub
allowUnicode
Set if unescaped non-ASCII characters are allowed.
Declaration
Swift

public var allowUnicode: Bool
Show on GitHub
lineBreak
Set the preferred line break.
Declaration
Swift

public var lineBreak: LineBreak
Show on GitHub
version
The %YAML directive value or nil.
Declaration
Swift

public var version: (major: Int, minor: Int)?
Show on GitHub
sortKeys
Set if emitter should sort keys in lexicographic order.
Declaration
Swift

public var sortKeys: Bool
Show on GitHub
sequenceStyle
Set the style for sequences (arrays / lists)
Declaration
Swift

public var sequenceStyle: Node.Sequence.Style
Show on GitHub
mappingStyle
Set the style for mappings (dictionaries)
Declaration
Swift

public var mappingStyle: Node.Mapping.Style
Show on GitHub
newLineScalarStyle
Set the style for scalars that include newlines
Declaration
Swift

public var newLineScalarStyle: Node.Scalar.Style
Show on GitHub

Options Initializer


                    
                    
                    init(canonical:indent:width:allowUnicode:lineBreak:version:sortKeys:sequenceStyle:mappingStyle:newLineScalarStyle:)

Create Emitter.Options with the specified values.

Declaration

Swift

public init(canonical: Bool = false, indent: Int = 0, width: Int = 0, allowUnicode: Bool = false,
            lineBreak: Emitter.LineBreak = .ln, version: (major: Int, minor: Int)? = nil,
            sortKeys: Bool = false, sequenceStyle: Node.Sequence.Style = .any,
            mappingStyle: Node.Mapping.Style = .any, newLineScalarStyle: Node.Scalar.Style = .any)

Parameters

`canonical`	Set if the output should be in the “canonical” format described in the YAML specification.
`indent`	Set the indentation value.
`width`	Set the preferred line width. -1 means unlimited.
`allowUnicode`	Set if unescaped non-ASCII characters are allowed.
`lineBreak`	Set the preferred line break.
`explicitStart`	Explicit document start `---`.
`explicitEnd`	Explicit document end `...`.
`version`	The `%YAML` directive value or nil.
`sortKeys`	Set if emitter should sort keys in lexicographic order.
`sequenceStyle`	Set the style for sequences (arrays / lists)
`mappingStyle`	Set the style for mappings (dictionaries)

Show on GitHub