Turf for Swift (87% documented)

GitHub View on GitHub

Dash Install in Dash

Turf Reference Consumer Enumeration Reference

Consumer

public indirect enum Consumer<Label> : Equatable, Sendable where Label : Hashable, Label : Sendable

extension Consumer: ExpressibleByStringLiteral, ExpressibleByArrayLiteral

extension Consumer: CustomStringConvertible

Undocumented

Show on GitHub

string(_:)
Primitives
Declaration
Swift

case string(String)
Show on GitHub
charset(_:)
Undocumented
Declaration
Swift

case charset(Charset)
Show on GitHub
any(_:)
Combinators
Declaration
Swift

case any([Consumer])
Show on GitHub
sequence(_:)
Undocumented
Declaration
Swift

case sequence([Consumer])
Show on GitHub
optional(_:)
Undocumented
Declaration
Swift

case optional(Consumer)
Show on GitHub
oneOrMore(_:)
Undocumented
Declaration
Swift

case oneOrMore(Consumer)
Show on GitHub
not(_:)
Undocumented
Declaration
Swift

case not(Consumer)
Show on GitHub
flatten(_:)
Transforms
Declaration
Swift

case flatten(Consumer)
Show on GitHub
discard(_:)
Undocumented
Declaration
Swift

case discard(Consumer)
Show on GitHub
replace(_:_:)
Undocumented
Declaration
Swift

case replace(Consumer, String)
Show on GitHub
label(_:_:)
References
Declaration
Swift

case label(Label, Consumer)
Show on GitHub
reference(_:)
Undocumented
Declaration
Swift

case reference(Label)
Show on GitHub

Matching

match(_:)
Parse input and return matched result
Declaration
Swift

func match(_ input: String) throws -> Match
Show on GitHub
isOptional
Will the consumer match empty input?
Declaration
Swift

var isOptional: Bool { get }
Show on GitHub


                    
                    
                    Location

Source location

See more

Declaration

Swift

struct Location : Equatable, Sendable

extension Consumer.Location: CustomStringConvertible

Show on GitHub


                    
                    
                    Match

Abstract syntax tree returned by consumer

See more

Declaration

Swift

indirect enum Match : Equatable, Sendable

extension Consumer.Match: CustomStringConvertible

Show on GitHub

Charset
Opaque type used for efficient character matching
See more
Declaration
Swift

struct Charset : Hashable, Sendable
Show on GitHub
Transform
Closure for transforming a Match to an application-specific data type
Declaration
Swift

typealias Transform = (_ name: Label, _ values: [Sendable]) throws -> (Sendable)?
Show on GitHub


                    
                    
                    Error

A Parsing error

See more

Declaration

Swift

struct Error : Swift.Error

extension Consumer.Error: CustomStringConvertible

Show on GitHub

Syntax sugar

init(stringLiteral:)
Create .string() consumer from a string literal
Declaration
Swift

public init(stringLiteral: String)
Show on GitHub
init(arrayLiteral:)
Create .sequence() consumer from an array literal
Declaration
Swift

public init(arrayLiteral: Consumer...)
Show on GitHub
|(_:_:)
Converts two consumers into an .any() consumer
Declaration
Swift

public static func | (lhs: Consumer, rhs: Consumer) -> Consumer
Show on GitHub

Character sets

character(_:)
Match a character
Declaration
Swift

static func character(_ c: UnicodeScalar) -> Consumer
Show on GitHub


                    
                    
                    character(in:)

Match character in range

Declaration

Swift

static func character(in range: ClosedRange<UnicodeScalar>) -> Consumer

Show on GitHub

character(in:)
Match character in string
Declaration
Swift

static func character(in string: String) -> Consumer
Show on GitHub
character(in:)
Match character in set
Declaration
Swift

static func character(in set: CharacterSet) -> Consumer
Show on GitHub
anyCharacter(except:)
Match any character except the one(s) specified
Declaration
Swift

static func anyCharacter(except characters: UnicodeScalar...) -> Consumer
Show on GitHub
anyCharacter(except:)
Match any character except the specified set
Declaration
Swift

static func anyCharacter(except set: CharacterSet) -> Consumer
Show on GitHub

Composite rules

zeroOrMore(_:)
Matches a list of zero or more consumer instances
Declaration
Swift

static func zeroOrMore(_ consumer: Consumer) -> Consumer
Show on GitHub
interleaved(_:_:)
Matches one or more consumer instances, separated by an instance of separator This is useful for something like a comma-delimited list (without a trailing comma)
Declaration
Swift

static func interleaved(_ consumer: Consumer, _ separator: Consumer) -> Consumer
Show on GitHub
ignore(_:in:)
Matches the target consumer, ignoring any instances of the ignored consumer This is useful for something like ignoring whitespace between tokens Note: Instances of ignored inside flatten clauses will not be ignored
Declaration
Swift

static func ignore(_ ignored: Consumer, in target: Consumer) -> Consumer
Show on GitHub

Consumer implementation

description
Human-readable description of what consumer matches
Declaration
Swift

public var description: String { get }
Show on GitHub