Constructor

public final class Constructor

Constructors are used to translate Nodes to Swift values.

Show on GitHub


                    
                    
                    ScalarMap

Maps Tag.Names to Node.Scalars.

Declaration

Swift

public typealias ScalarMap = [Tag.Name : (Node.Scalar) -> Any?]

Show on GitHub


                    
                    
                    MappingMap

Maps Tag.Names to Node.Mappings.

Declaration

Swift

public typealias MappingMap = [Tag.Name : (Node.Mapping) -> Any?]

Show on GitHub


                    
                    
                    SequenceMap

Maps Tag.Names to Node.Sequences.

Declaration

Swift

public typealias SequenceMap = [Tag.Name : (Node.Sequence) -> Any?]

Show on GitHub


                    
                    
                    init(_:_:_:)

Initialize a Constructor with the specified maps, falling back to default maps.

Declaration

Swift

public init(_ scalarMap: ScalarMap = defaultScalarMap,
            _ mappingMap: MappingMap = defaultMappingMap,
            _ sequenceMap: SequenceMap = defaultSequenceMap)

Parameters

`scalarMap`	Maps `Tag.Name`s to `Node.Scalar`s.
`mappingMap`	Maps `Tag.Name`s to `Node.Mapping`s.
`sequenceMap`	Maps `Tag.Name`s to `Node.Sequence`s.

Show on GitHub


                    
                    
                    any(from:)

Constructs Swift values based on the maps this Constructor was initialized with.

Declaration

Swift

public func any(from node: Node) -> Any

Parameters


                                node

Node from which to extract an Any Swift value, if one was produced by the Node type’s relevant mapping on this Constructor.

Return Value

An Any Swift value, if one was produced by the Node type’s relevant mapping on this Constructor.

Show on GitHub

Default Mappings

default
The default Constructor to be used with APIs where none is explicitly provided.
Declaration
Swift

public static let `default`: Constructor
Show on GitHub
defaultScalarMap
The default Tag.Name to Node.Scalar map.
Declaration
Swift

public static let defaultScalarMap: ScalarMap
Show on GitHub
defaultMappingMap
The default Tag.Name to Node.Mapping map.
Declaration
Swift

public static let defaultMappingMap: MappingMap
Show on GitHub
defaultSequenceMap
The default Tag.Name to Node.Sequence map.
Declaration
Swift

public static let defaultSequenceMap: SequenceMap
Show on GitHub