A switch expression.
struct SwitchExprSyntaxThis represents the switch expression in
switch self.foo {
}A switch ecpression may be declared without any cases.
switchKeyword: switch
subject: ExprSyntax
leftBrace: {
cases: SwitchCaseListSyntax
rightBrace: }
import SwiftSyntaxA library for working with Swift code.
struct ExprSyntaxstruct SwitchCaseListSyntaxprotocol ExprSyntaxProtocol : SyntaxProtocolProtocol to which all ExprSyntax nodes conform.
struct MissingExprSyntaxIn case the source code is missing an expression, this node stands in place of the missing expression.
struct ArrayExprSyntaxAn array literal.
struct ArrowExprSyntaxThe arrow when a type is used at a position that syntactically expectes an expression.
struct AsExprSyntaxThe cast of an expressison to a different type.
struct AssignmentExprSyntaxstruct AwaitExprSyntaxstruct BinaryOperatorExprSyntaxAn operator like + or -.
struct BooleanLiteralExprSyntaxstruct BorrowExprSyntaxstruct ClosureExprSyntaxstruct ConsumeExprSyntaxstruct CopyExprSyntaxstruct DeclReferenceExprSyntaxstruct DictionaryExprSyntaxA dictionary literal
struct DiscardAssignmentExprSyntaxA _ that discards a value inside an assignment.
struct EditorPlaceholderExprSyntaxstruct FloatLiteralExprSyntaxstruct ForceUnwrapExprSyntaxstruct FunctionCallExprSyntaxstruct GenericSpecializationExprSyntaxstruct IfExprSyntaxstruct InOutExprSyntaxAn expression prefixed with & to pass an argument to an inout parameter.
struct InfixOperatorExprSyntaxAn infix operator call like 1 + 2.
struct IntegerLiteralExprSyntaxstruct IsExprSyntaxChecks if an expression is of a given type.
struct KeyPathExprSyntaxA key path.
struct MacroExpansionExprSyntaxThe expansion of a freestanding macro in a position that expects an expression.
struct MemberAccessExprSyntaxAn expression that access a member like a function or a property.
struct NilLiteralExprSyntaxstruct OptionalChainingExprSyntaxstruct PackElementExprSyntaxA pack element expression spelled with each.
struct PackExpansionExprSyntaxA pack expansion expression spelled with repeat.
struct PatternExprSyntaxstruct PostfixIfConfigExprSyntaxstruct PostfixOperatorExprSyntaxstruct PrefixOperatorExprSyntaxA prefix operator applied to a value.
struct RegexLiteralExprSyntaxstruct SequenceExprSyntaxA flat list of expressions before operator folding using the SwiftOperators library.
struct SimpleStringLiteralExprSyntaxA simple string that can’t contain string interpolation and cannot have raw string delimiters.
struct StringLiteralExprSyntaxA string literal.
struct SubscriptCallExprSyntaxstruct SuperExprSyntaxstruct TernaryExprSyntaxThe ternary operator with operator precedences resolved.
struct TryExprSyntaxAn expression prefixed with try.
struct TupleExprSyntaxstruct TypeExprSyntaxstruct UnresolvedAsExprSyntaxThe as keyword without any operands.
struct UnresolvedIsExprSyntaxThe is keyword without any operands.
struct UnresolvedTernaryExprSyntaxThe middle section of a ternary operator between ? and :.
protocol BracedSyntax : SyntaxProtocol/ Automatically generated by generate-swift-syntax / Do not edit directly!
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Sendableprotocol SyntaxHashable : HashableProtocol that provides a common Hashable implementation for all syntax nodes
protocol SyntaxProtocol : CustomDebugStringConvertible, CustomReflectable, CustomStringConvertible, Sendable, TextOutputStreamableProvide common functionality for specialized syntax nodes. Extend this protocol to provide common functionality for all syntax nodes.
protocol TextOutputStreamableA source of text-streaming operations.
protocol _LeafExprSyntaxNodeProtocol : ExprSyntaxProtocolProtocol that syntax nodes conform to if they don’t have any semantic subtypes. These are syntax nodes that are not considered base nodes for other syntax types.
init?(_ node: some SyntaxProtocol) init(leadingTrivia: Trivia? = nil, _ unexpectedBeforeSwitchKeyword: UnexpectedNodesSyntax? = nil, switchKeyword: TokenSyntax = .keyword(.switch), _ unexpectedBetweenSwitchKeywordAndSubject: UnexpectedNodesSyntax? = nil, subject: some ExprSyntaxProtocol, _ unexpectedBetweenSubjectAndLeftBrace: UnexpectedNodesSyntax? = nil, leftBrace: TokenSyntax = .leftBraceToken(), _ unexpectedBetweenLeftBraceAndCases: UnexpectedNodesSyntax? = nil, cases: SwitchCaseListSyntax, _ unexpectedBetweenCasesAndRightBrace: UnexpectedNodesSyntax? = nil, rightBrace: TokenSyntax = .rightBraceToken(), _ unexpectedAfterRightBrace: UnexpectedNodesSyntax? = nil, trailingTrivia: Trivia? = nil) static let structure: SyntaxNodeStructurelet _syntaxNode: Syntaxvar cases: SwitchCaseListSyntax { get set }The switch’s body that contains all possible cases.
var leftBrace: TokenSyntax { get set }The brace introducing the switch body.
var rightBrace: TokenSyntax { get set }The brace closing the switch body.
var subject: ExprSyntax { get set }The expression to switch over.
var switchKeyword: TokenSyntax { get set }The switch keyword.
var unexpectedAfterRightBrace: UnexpectedNodesSyntax? { get set }var unexpectedBeforeSwitchKeyword: UnexpectedNodesSyntax? { get set }var unexpectedBetweenCasesAndRightBrace: UnexpectedNodesSyntax? { get set }var unexpectedBetweenLeftBraceAndCases: UnexpectedNodesSyntax? { get set }var unexpectedBetweenSubjectAndLeftBrace: UnexpectedNodesSyntax? { get set }var unexpectedBetweenSwitchKeywordAndSubject: UnexpectedNodesSyntax? { get set }init(leadingTrivia: Trivia? = nil, _ unexpectedBeforeSwitchKeyword: UnexpectedNodesSyntax? = nil, switchKeyword: TokenSyntax = .keyword(.switch), _ unexpectedBetweenSwitchKeywordAndExpression: UnexpectedNodesSyntax? = nil, expression: some ExprSyntaxProtocol, _ unexpectedBetweenExpressionAndLeftBrace: UnexpectedNodesSyntax? = nil, leftBrace: TokenSyntax = .leftBraceToken(), _ unexpectedBetweenLeftBraceAndCases: UnexpectedNodesSyntax? = nil, cases: SwitchCaseListSyntax, _ unexpectedBetweenCasesAndRightBrace: UnexpectedNodesSyntax? = nil, rightBrace: TokenSyntax = .rightBraceToken(), _ unexpectedAfterRightBrace: UnexpectedNodesSyntax? = nil, trailingTrivia: Trivia? = nil) var expression: ExprSyntax { get set }var unexpectedBetweenExpressionAndLeftBrace: UnexpectedNodesSyntax? { get set }var unexpectedBetweenSwitchKeywordAndExpression: UnexpectedNodesSyntax? { get set }func addCase(_ element: Syntax) -> SwitchExprSyntax Adds the provided element to the node’s cases collection.
init?<S>(_ node: S?) where S : SyntaxProtocol Initializes a new instance of the conforming type from a given specialized syntax node.
var customMirror: Mirror { get }var debugDescription: String { get }A simple description of this node (ie. its type).
var description: String { get }A source-accurate description of this node.
var detached: Self { get }Return this subtree with this node as the root, ie. detach this node from its parent.
var endPosition: AbsolutePosition { get }The end position of this node, including its trivia.
var endPositionBeforeTrailingTrivia: AbsolutePosition { get }The end position of this node’s content, before any trailing trivia.
var hasError: Bool { get }Whether the tree contained by this layout has any
var hasMaximumNestingLevelOverflow: Bool { get }var hasParent: Bool { get }Whether or not this node has a parent.
var hasSequenceExpr: Bool { get }Whether this tree contains a missing token or unexpected node.
var hasWarning: Bool { get }Whether the tree contained by this layout has any tokens with a TokenDiagnostic of severity warning.
var id: SyntaxIdentifier { get }Returns a value representing the unique identity of the node.
var keyPathInParent: AnyKeyPath? { get }var kind: SyntaxKind { get }The kind of the syntax node, e.g. if it is a functionDecl.
var leadingTrivia: Trivia { get set }The leading trivia of this syntax node.
var leadingTriviaLength: SourceLength { get }The length this node’s leading trivia takes up spelled out in source.
var parent: Syntax? { get }The parent of this syntax node, or nil if this node is the root.
var position: AbsolutePosition { get }The absolute position of the starting point of this node. If the first token is with leading trivia, the position points to the start of the leading trivia.
var positionAfterSkippingLeadingTrivia: AbsolutePosition { get }The absolute position of the starting point of this node, skipping any leading trivia attached to the first token syntax.
var raw: RawSyntax { get }var root: Syntax { get }The root of the tree in which this node resides.
var syntaxNodeType: SyntaxProtocol.Type { get }The dynamic metatype of the concrete node.
var syntaxTextBytes: [UInt8] { get }Retrieve the syntax text as an array of bytes that models the input source even in the presence of invalid UTF-8.
var totalByteRange: ByteSourceRange { get }The byte source range of this node including leading and trailing trivia.
var totalLength: SourceLength { get }The length of this node including all of its trivia.
var trailingTrivia: Trivia { get set }The trailing trivia of this syntax node.
var trailingTriviaLength: SourceLength { get }The length this node’s trailing trivia takes up spelled out in source.
var trimmed: Self { get }A copy of this node without the leading trivia of the first token in the node and the trailing trivia of the last token in the node.
var trimmedByteRange: ByteSourceRange { get }The byte source range of this node excluding leading and trailing trivia.
var trimmedDescription: String { get }The description of this node with leading whitespace of the first token and trailing whitespace of the last token removed.
var trimmedLength: SourceLength { get }The length this node takes up spelled out in the source, excluding its leading or trailing trivia.
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func == (lhs: Self, rhs: Self) -> Bool func asProtocol(_: MissingNodeSyntax.Protocol) -> MissingNodeSyntax? Return the non-type erased version of this syntax node if it conforms to MissingNodeSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: ParenthesizedSyntax.Protocol) -> ParenthesizedSyntax? Return the non-type erased version of this syntax node if it conforms to ParenthesizedSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithCodeBlockSyntax.Protocol) -> WithCodeBlockSyntax? Return the non-type erased version of this syntax node if it conforms to WithCodeBlockSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithModifiersSyntax.Protocol) -> WithModifiersSyntax? Return the non-type erased version of this syntax node if it conforms to WithModifiersSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithAttributesSyntax.Protocol) -> WithAttributesSyntax? Return the non-type erased version of this syntax node if it conforms to WithAttributesSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithStatementsSyntax.Protocol) -> WithStatementsSyntax? Return the non-type erased version of this syntax node if it conforms to WithStatementsSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: EffectSpecifiersSyntax.Protocol) -> EffectSpecifiersSyntax? Return the non-type erased version of this syntax node if it conforms to EffectSpecifiersSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithTrailingCommaSyntax.Protocol) -> WithTrailingCommaSyntax? Return the non-type erased version of this syntax node if it conforms to WithTrailingCommaSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithGenericParametersSyntax.Protocol) -> WithGenericParametersSyntax? Return the non-type erased version of this syntax node if it conforms to WithGenericParametersSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> WithOptionalCodeBlockSyntax? Return the non-type erased version of this syntax node if it conforms to WithOptionalCodeBlockSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: FreestandingMacroExpansionSyntax.Protocol) -> FreestandingMacroExpansionSyntax? Return the non-type erased version of this syntax node if it conforms to FreestandingMacroExpansionSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: BracedSyntax.Protocol) -> BracedSyntax? Return the non-type erased version of this syntax node if it conforms to BracedSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: DeclGroupSyntax.Protocol) -> DeclGroupSyntax? Return the non-type erased version of this syntax node if it conforms to DeclGroupSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func asProtocol(_: NamedDeclSyntax.Protocol) -> NamedDeclSyntax? Return the non-type erased version of this syntax node if it conforms to NamedDeclSyntax. Otherwise return nil. Note that this will incur an existential conversion.
func children(viewMode: SyntaxTreeViewMode) -> SyntaxChildren A sequence over the children of this node.
func debugDescription(includeTrivia: Bool = false, converter: SourceLocationConverter? = nil, mark: SyntaxProtocol? = nil, indentString: String = "") -> String Returns a summarized dump of this node.
func endLocation(converter: SourceLocationConverter, afterTrailingTrivia: Bool = false) -> SourceLocation The ending location, in the provided file, of this Syntax node.
func firstToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax? Returns the first token node that is part of this syntax node.
func hash(into hasher: inout Hasher) func isProtocol(_: MissingNodeSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to MissingNodeSyntax. Note that this will incur an existential conversion.
func isProtocol(_: ParenthesizedSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to ParenthesizedSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithCodeBlockSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithCodeBlockSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithModifiersSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithModifiersSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithAttributesSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithAttributesSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithStatementsSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithStatementsSyntax. Note that this will incur an existential conversion.
func isProtocol(_: EffectSpecifiersSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to EffectSpecifiersSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithTrailingCommaSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithTrailingCommaSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithGenericParametersSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithGenericParametersSyntax. Note that this will incur an existential conversion.
func isProtocol(_: WithOptionalCodeBlockSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to WithOptionalCodeBlockSyntax. Note that this will incur an existential conversion.
func isProtocol(_: FreestandingMacroExpansionSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to FreestandingMacroExpansionSyntax. Note that this will incur an existential conversion.
func isProtocol(_: BracedSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to BracedSyntax. Note that this will incur an existential conversion.
func isProtocol(_: DeclGroupSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to DeclGroupSyntax. Note that this will incur an existential conversion.
func isProtocol(_: NamedDeclSyntax.Protocol) -> Bool Check whether the non-type erased version of this syntax node conforms to NamedDeclSyntax. Note that this will incur an existential conversion.
func lastToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax? Returns the last token node that is part of this syntax node.
func nextToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax? Recursively walks through the tree to find the next token semantically after this node.
func node(at syntaxIdentifier: SyntaxIdentifier) -> Syntax? If the node with the given syntaxIdentifier is a (recursive) child of this node, return the node with that identifier.
func previousToken(viewMode: SyntaxTreeViewMode) -> TokenSyntax? Recursively walks through the tree to find the token semantically before this node.
func sourceRange(converter: SourceLocationConverter, afterLeadingTrivia: Bool = true, afterTrailingTrivia: Bool = false) -> SourceRange The source range, in the provided file, of this Syntax node.
func startLocation(converter: SourceLocationConverter, afterLeadingTrivia: Bool = true) -> SourceLocation The starting location, in the provided file, of this Syntax node.
func token(at position: AbsolutePosition) -> TokenSyntax? Find the syntax token at the given absolute position within this syntax node or any of its children.
func tokens(viewMode: SyntaxTreeViewMode) -> TokenSequence Sequence of tokens that are part of this Syntax node.
func trimmed(matching filter: (TriviaPiece) -> Bool) -> Self A copy of this node with pieces that match matching trimmed from the leading trivia of the first token and trailing trivia of the last token.
func trimmedDescription(matching filter: (TriviaPiece) -> Bool) -> String The description of this node with pieces that match matching removed from the leading trivia of the first token and trailing trivia of the last token.
func with<T>(_ keyPath: WritableKeyPath<BracedSyntax, T>, _ newChild: T) -> BracedSyntax Without this function, the with function defined on SyntaxProtocol does not work on existentials of this protocol type.
func with<T>(_ keyPath: WritableKeyPath<Self, T>, _ value: T) -> Self Returns a new syntax node that has the child at keyPath replaced by value.
func write<Target>(to target: inout Target) where Target : TextOutputStream Prints the raw value of this node to the provided stream.
var byteRange: ByteSourceRange { get }var byteSize: Int { get }The textual byte length of this node including leading and trailing trivia.
var byteSizeAfterTrimmingTrivia: Int { get }The textual byte length of this node excluding leading and trailing trivia.
var contentLength: SourceLength { get }var firstToken: TokenSyntax? { get }var index: SyntaxChildrenIndex { get }The index of this node in a SyntaxChildren collection.
var isImplicit: Bool { get }When isImplicit is true, the syntax node doesn’t include any underlying tokens, e.g. an empty CodeBlockItemList.
var lastToken: TokenSyntax? { get }var nextToken: TokenSyntax? { get }var previousToken: TokenSyntax? { get }func `as`(_ syntaxType: ExprSyntax.Type) -> ExprSyntax? Attempts to upcast the current syntax node to its base node type (ExprSyntax).
func cast(_ syntaxType: ExprSyntax.Type) -> ExprSyntax Force-upcast the current syntax node to its base node type (ExprSyntax).
func detach() -> Self func `is`(_ syntaxType: ExprSyntax.Type) -> Bool Checks if the current syntax node can be upcast to its base node type (ExprSyntax).
import SwiftSyntaxBuilderSwiftSyntaxBuilder is a tool for generating Swift code in a convenient way using result builders.
init(_ header: SyntaxNodeString, @SwitchCaseListBuilder casesBuilder: () throws -> SwitchCaseListSyntax = { SwitchCaseListSyntax([]) }) throws Constructs a switch expression where header builds the text before the opening { and casesBuilder can be used to build the case items.
init(leadingTrivia: Trivia? = nil, unexpectedBeforeSwitchKeyword: UnexpectedNodesSyntax? = nil, switchKeyword: TokenSyntax = .keyword(.switch), unexpectedBetweenSwitchKeywordAndSubject: UnexpectedNodesSyntax? = nil, subject: ExprSyntaxProtocol, unexpectedBetweenSubjectAndLeftBrace: UnexpectedNodesSyntax? = nil, leftBrace: TokenSyntax = .leftBraceToken(), unexpectedBetweenLeftBraceAndCases: UnexpectedNodesSyntax? = nil, unexpectedBetweenCasesAndRightBrace: UnexpectedNodesSyntax? = nil, rightBrace: TokenSyntax = .rightBraceToken(), unexpectedAfterRightBrace: UnexpectedNodesSyntax? = nil, @SwitchCaseListBuilder casesBuilder: () throws -> SwitchCaseListSyntax, trailingTrivia: Trivia? = nil) rethrows A convenience initializer that allows initializing syntax collections using result builders
init(leadingTrivia: Trivia? = nil, unexpectedBeforeSwitchKeyword: UnexpectedNodesSyntax? = nil, switchKeyword: TokenSyntax = .keyword(.switch), unexpectedBetweenSwitchKeywordAndExpression: UnexpectedNodesSyntax? = nil, expression: ExprSyntaxProtocol, unexpectedBetweenExpressionAndLeftBrace: UnexpectedNodesSyntax? = nil, leftBrace: TokenSyntax = .leftBraceToken(), unexpectedBetweenLeftBraceAndCases: UnexpectedNodesSyntax? = nil, unexpectedBetweenCasesAndRightBrace: UnexpectedNodesSyntax? = nil, rightBrace: TokenSyntax = .rightBraceToken(), unexpectedAfterRightBrace: UnexpectedNodesSyntax? = nil, @SwitchCaseListBuilder casesBuilder: () throws -> SwitchCaseListSyntax, trailingTrivia: Trivia? = nil) rethrows