Represents the raw tree structure underlying the syntax tree. These nodes have no notion of identity and only provide structure to the tree. They are immutable and can be freely shared between syntax nodes.
This declaration is gated by at least one @_spi attribute.
struct RawSyntaximport SwiftSyntaxA library for working with Swift code.
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 Escapableprotocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol RawSyntaxNodeProtocol : CustomStringConvertible, Sendable, TextOutputStreamableAll typed raw syntax nodes conform to this protocol. RawXXXSyntax is a typed wrappeer of RawSyntax.
protocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
protocol TextOutputStreamableA source of text-streaming operations.
init(_ other: some RawSyntaxNodeProtocol) static func isKindOf(_ raw: RawSyntax) -> Bool static func makeLayout(kind: SyntaxKind, uninitializedCount count: Int, isMaximumNestingLevelOverflow: Bool = false, arena: SyntaxArena, initializingWith initializer: (UnsafeMutableBufferPointer<RawSyntax?>) -> Void) -> RawSyntax Factory method to create a layout node.
static func makeMaterializedToken(kind: RawTokenKind, text: SyntaxText, leadingTriviaPieceCount: Int, trailingTriviaPieceCount: Int, presence: SourcePresence, tokenDiagnostic: TokenDiagnostic?, arena: SyntaxArena, initializingLeadingTriviaWith: (UnsafeMutableBufferPointer<RawTriviaPiece>) -> Void, initializingTrailingTriviaWith: (UnsafeMutableBufferPointer<RawTriviaPiece>) -> Void) -> RawSyntax Factory method to create a materialized token node.
var byteLength: Int { get }The “width” of the node.
var customMirror: Mirror { get }var debugDescription: String { get }var description: String { get }A source-accurate description of this node.
var id: RawSyntax.ID { get }var isToken: Bool { get }Whether or not this node is a token one.
var kind: SyntaxKind { get }The syntax kind of this raw syntax.
var layoutView: RawSyntaxLayoutView? { get }A view into the RawSyntax that exposes functionality that’s specific to layout nodes. The token’s payload must be a layout, otherwise this traps.
var leadingTriviaByteLength: Int { get }var leadingTriviaPieces: [RawTriviaPiece]? { get }var raw: RawSyntax { get }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 tokenView: RawSyntaxTokenView? { get }A view into the RawSyntax that exposes functionality that’s specific to tokens. The token’s payload must be a token, otherwise this traps.
var trailingTriviaByteLength: Int { get }var trailingTriviaPieces: [RawTriviaPiece]? { get }func withEachSyntaxText(body: (SyntaxText, Bool) throws -> Void) rethrows Enumerate all of the syntax text present in this node, and all of its children, to give a source-accurate view of the bytes.
func withLeadingTrivia(_ leadingTrivia: Trivia, arena: SyntaxArena) -> RawSyntax? Replaces the leading trivia of the first token in this syntax tree by leadingTrivia. If the syntax tree did not contain a token and thus no trivia could be attached to it, nil is returned.
func withTrailingTrivia(_ trailingTrivia: Trivia, arena: SyntaxArena) -> RawSyntax? Replaces the trailing trivia of the last token in this syntax tree by trailingTrivia. If the syntax tree did not contain a token and thus no trivia could be attached to it, nil is returned.
func write<Target>(to target: inout Target) where Target : TextOutputStream Prints the RawSyntax node, and all of its children, to the provided stream. This implementation must be source-accurate.
struct IDvar hasError: Bool { get }Whether the tree contained by this layout has any
var isEmpty: Bool { get }func `as`<Node>(_: Node.Type) -> Node? where Node : RawSyntaxNodeProtocol Cast to the specified raw syntax type if possible.
func cast<S>(_ syntaxType: S.Type) -> S where S : RawSyntaxNodeProtocol func `is`<Node>(_: Node.Type) -> Bool where Node : RawSyntaxNodeProtocol Check if this instance can be cast to the specified syntax type.
func write(to target: inout some TextOutputStream)