Node Enumeration Reference

scalar(_:)
Scalar node.
Declaration
Swift

case scalar(Scalar)
Show on GitHub
mapping(_:)
Mapping node.
Declaration
Swift

case mapping(Mapping)
Show on GitHub
sequence(_:)
Sequence node.
Declaration
Swift

case sequence(Sequence)
Show on GitHub
alias(_:)
Alias node.
Declaration
Swift

case alias(Alias)
Show on GitHub

Node+Alias


                    
                    
                    Alias

Scalar node.

Declaration

Swift

public struct Alias

extension Node.Alias: Comparable

extension Node.Alias: Equatable

extension Node.Alias: Hashable

Show on GitHub


                    
                    
                    Mapping

A mapping is the YAML equivalent of a Dictionary.

Declaration

Swift

public struct Mapping

extension Node.Mapping: Comparable

extension Node.Mapping: Equatable

extension Node.Mapping: Hashable

extension Node.Mapping: ExpressibleByDictionaryLiteral

extension Node.Mapping: MutableCollection

Show on GitHub

mapping
Get or set the Node.Mapping value if this node is a Node.mapping.
Declaration
Swift

public var mapping: Mapping? { get set }
Show on GitHub

Node+Scalar


                    
                    
                    Scalar

Scalar node.

Declaration

Swift

public struct Scalar

extension Node.Scalar: Comparable

extension Node.Scalar: Equatable

extension Node.Scalar: Hashable

Show on GitHub

scalar
Get or set the Node.Scalar value if this node is a Node.scalar.
Declaration
Swift

public var scalar: Scalar? { get set }
Show on GitHub
alias
Get or set the Node.Alias value if this node is a Node.alias.
Declaration
Swift

public var alias: Alias? { get set }
Show on GitHub

Node+Sequence


                    
                    
                    Sequence

Sequence node.

Declaration

Swift

public struct Sequence

extension Node.Sequence: Comparable

extension Node.Sequence: Equatable

extension Node.Sequence: Hashable

extension Node.Sequence: ExpressibleByArrayLiteral

extension Node.Sequence: MutableCollection

extension Node.Sequence: RandomAccessCollection

extension Node.Sequence: RangeReplaceableCollection

Show on GitHub

sequence
Get or set the Node.Sequence value if this node is a Node.sequence.
Declaration
Swift

public var sequence: Sequence? { get set }
Show on GitHub


                    
                    
                    init(_:_:_:_:)

Create a Node.scalar with a string, tag & scalar style.

Declaration

Swift

public init(_ string: String,
            _ tag: Tag = .implicit,
            _ style: Scalar.Style = .any,
            _ anchor: Anchor? = nil)

Parameters

`string`	String value for this node.
`tag`	Tag for this node.
`style`	Style to use when emitting this node.

Show on GitHub


                    
                    
                    init(_:_:_:_:)

Create a Node.mapping with a sequence of node pairs, tag & scalar style.

Declaration

Swift

public init(_ pairs: [(Node, Node)],
            _ tag: Tag = .implicit,
            _ style: Mapping.Style = .any,
            _ anchor: Anchor? = nil)

Parameters

`pairs`	Pairs of nodes to use for this node.
`tag`	Tag for this node.
`style`	Style to use when emitting this node.

Show on GitHub


                    
                    
                    init(_:_:_:_:)

Create a Node.sequence with a sequence of nodes, tag & scalar style.

Declaration

Swift

public init(_ nodes: [Node],
            _ tag: Tag = .implicit,
            _ style: Sequence.Style = .any,
            _ anchor: Anchor? = nil)

Parameters

`nodes`	Sequence of nodes to use for this node.
`tag`	Tag for this node.
`style`	Style to use when emitting this node.

Show on GitHub

Public Node Members

tag
The tag for this node.

Note
Accessing this property causes the tag to be resolved by tag.resolver.
Declaration
Swift

public var tag: Tag { get }
Show on GitHub
mark
The location for this node.
Declaration
Swift

public var mark: Mark? { get }
Show on GitHub
anchor
The anchor for this node.
Declaration
Swift

public var anchor: Anchor? { get }
Show on GitHub

Typed accessor properties

any
This node as an Any, if convertible.
Declaration
Swift

public var any: Any { get }
Show on GitHub
string
This node as a String, if convertible.
Declaration
Swift

public var string: String? { get }
Show on GitHub
bool
This node as a Bool, if convertible.
Declaration
Swift

public var bool: Bool? { get }
Show on GitHub
float
This node as a Double, if convertible.
Declaration
Swift

public var float: Double? { get }
Show on GitHub
null
This node as an NSNull, if convertible.
Declaration
Swift

public var null: NSNull? { get }
Show on GitHub
int
This node as an Int, if convertible.
Declaration
Swift

public var int: Int? { get }
Show on GitHub
binary
This node as a Data, if convertible.
Declaration
Swift

public var binary: Data? { get }
Show on GitHub
timestamp
This node as a Date, if convertible.
Declaration
Swift

public var timestamp: Date? { get }
Show on GitHub
uuid
This node as a UUID, if convertible.
Declaration
Swift

public var uuid: UUID? { get }
Show on GitHub

Typed accessor methods

array()
Returns this node mapped as an Array<Node>. If the node isn’t a Node.sequence, the array will be empty.
Declaration
Swift

public func array() -> [Node]
Show on GitHub


                    
                    
                    array(of:)

Typed Array using type parameter: e.g. array(of: String.self).

Declaration

Swift

public func array<Type>(of type: Type.Type = Type.self) -> [Type] where Type : ScalarConstructible

Parameters


                                type

Type conforming to ScalarConstructible.

Return Value

Array of Type.

Show on GitHub

subscript(_:)
If the node is a .sequence or .mapping, set or get the specified Node. If the node is a .scalar, this is a no-op.
Declaration
Swift

public subscript(node: Node) -> Node? { get set }
Show on GitHub
subscript(_:)
If the node is a .sequence or .mapping, set or get the specified parameter’s Node representation. If the node is a .scalar, this is a no-op.
Declaration
Swift

public subscript(representable: NodeRepresentable) -> Node? { get set }
Show on GitHub
subscript(_:)
If the node is a .sequence or .mapping, set or get the specified string’s Node representation. If the node is a .scalar, this is a no-op.
Declaration
Swift

public subscript(string: String) -> Node? { get set }
Show on GitHub

Comparable


                    
                    
                    <(_:_:)

Returns true if lhs is ordered before rhs.

Declaration

Swift

public static func < (lhs: Node, rhs: Node) -> Bool

Parameters

`lhs`	The left hand side Node to compare.
`rhs`	The right hand side Node to compare.

Return Value

True if lhs is ordered before rhs.

Show on GitHub

ExpressibleBy*Literal

init(arrayLiteral:)
Create a Node.sequence from an array literal of Nodes.
Declaration
Swift

public init(arrayLiteral elements: Node...)
Show on GitHub
init(arrayLiteral:style:)
Create a Node.sequence from an array literal of Nodes and a default Style to use for the array literal
Declaration
Swift

public init(arrayLiteral elements: Node..., style: Sequence.Style)
Show on GitHub
init(dictionaryLiteral:)
Create a Node.mapping from a dictionary literal of Nodes.
Declaration
Swift

public init(dictionaryLiteral elements: (Node, Node)...)
Show on GitHub
init(dictionaryLiteral:style:)
Create a Node.mapping from a dictionary literal of Nodes and a default Style to use for the dictionary literal.
Declaration
Swift

public init(dictionaryLiteral elements: (Node, Node)..., style: Mapping.Style)
Show on GitHub
init(floatLiteral:)
Create a Node.scalar from a float literal.
Declaration
Swift

public init(floatLiteral value: Double)
Show on GitHub
init(integerLiteral:)
Create a Node.scalar from an integer literal.
Declaration
Swift

public init(integerLiteral value: Int)
Show on GitHub
init(stringLiteral:)
Create a Node.scalar from a string literal.
Declaration
Swift

public init(stringLiteral value: String)
Show on GitHub


                    
                    
                    init(_:)

Initialize a Node with a value of NodeRepresentable.

Throws

YamlError.

Declaration

Swift

init<T>(_ representable: T) throws where T : NodeRepresentable

Parameters


                                representable

Value of NodeRepresentable to represent as a Node.

Show on GitHub

NodeRepresentable

represented()
This value’s Node representation.
Declaration
Swift

public func represented() throws -> Node
Show on GitHub