SyntaxTrivia Struct

A run of text a parser keeps but does not give meaning to, such as whitespace or a comment.

public readonly struct SyntaxTrivia : IEquatable<SyntaxTrivia>

Remarks

Trivia belongs to a token: it is either the leading or the trailing trivia of the token it sits beside.

Implements

Properties

NameDescription
ContainsAnnotations
ContainsDiagnostics
FullSpan
Parent
RawKindGets the language-specific kind of this trivia as a plain integer.
SpanGets the range this trivia covers. Trivia has no trivia of its own, so this is also its full span.
SpanStart
TokenGets the token this trivia belongs to.

ContainsAnnotations

SyntaxTrivia.cs
public bool ContainsAnnotations { get; }

Property value

bool

No documentation is available.

ContainsDiagnostics

SyntaxTrivia.cs
public bool ContainsDiagnostics { get; }

Property value

bool

No documentation is available.

public TextSpan FullSpan { get; }

Property value

TextSpan

No documentation is available.

public SyntaxNode? Parent { get; }

Property value

SyntaxNode?

No documentation is available.

Gets the language-specific kind of this trivia as a plain integer.

public int RawKind { get; }

Property value

int

Gets the range this trivia covers. Trivia has no trivia of its own, so this is also its full span.

public TextSpan Span { get; }

Property value

TextSpan

public int SpanStart { get; }

Property value

int

No documentation is available.

Gets the token this trivia belongs to.

public SyntaxToken Token { get; }

Property value

SyntaxToken

Methods

NameDescription
Equals(SyntaxTrivia)
Equals(object?)
GetAnnotations()Gets all the annotations of this trivia.
GetAnnotations(string)Gets the annotations of this trivia of the given kind.
GetHashCode()
HasAnnotation(SyntaxAnnotation?)Determines whether this trivia carries annotation.
HasAnnotations(string)Determines whether this trivia carries an annotation of the given kind.
IsEquivalentTo(SyntaxTrivia)Determines whether the two trivia have the same kind and text.
ToFullString()Returns the text of this trivia, which is the same as SyntaxTrivia.ToString because trivia has no trivia.
ToString()Returns the text of this trivia.
WithAdditionalAnnotations(SyntaxAnnotation[])Returns this trivia carrying annotations as well as the ones it already has.
WithoutAnnotations(SyntaxAnnotation[])Returns this trivia without annotations.
WriteTo(TextWriter)

Equals overloads

Equals(SyntaxTrivia)

SyntaxTrivia.cs
public bool Equals(SyntaxTrivia other)
Parameters
other SyntaxTrivia
Returns

bool

No documentation is available.

Equals(object?)

SyntaxTrivia.cs
public override bool Equals(object? obj)
Parameters
obj object?
Returns

bool

No documentation is available.

GetAnnotations overloads

GetAnnotations()

SyntaxTrivia.cs

Gets all the annotations of this trivia.

public IEnumerable<SyntaxAnnotation> GetAnnotations()

GetAnnotations(string)

SyntaxTrivia.cs

Gets the annotations of this trivia of the given kind.

public IEnumerable<SyntaxAnnotation> GetAnnotations(string annotationKind)
Parameters
annotationKind string
Returns

IEnumerable<SyntaxAnnotation>

Exceptions
ArgumentNullException
annotationKind is null.

GetHashCode()

SyntaxTrivia.cs
public override int GetHashCode()

Returns

int

No documentation is available.

HasAnnotation(SyntaxAnnotation?)

SyntaxTrivia.cs

Determines whether this trivia carries annotation.

public bool HasAnnotation(SyntaxAnnotation? annotation)

Parameters

annotation SyntaxAnnotation?

Returns

bool

HasAnnotations(string)

SyntaxTrivia.cs

Determines whether this trivia carries an annotation of the given kind.

public bool HasAnnotations(string annotationKind)

Parameters

annotationKind string

Returns

bool

IsEquivalentTo(SyntaxTrivia)

SyntaxTrivia.cs

Determines whether the two trivia have the same kind and text.

public bool IsEquivalentTo(SyntaxTrivia trivia)

Parameters

trivia SyntaxTrivia

Returns

bool

ToFullString()

SyntaxTrivia.cs

Returns the text of this trivia, which is the same as SyntaxTrivia.ToString because trivia has no trivia.

public string ToFullString()

Returns

string

ToString()

SyntaxTrivia.cs

Returns the text of this trivia.

public override string ToString()

Returns

string

WithAdditionalAnnotations(SyntaxAnnotation[])

SyntaxTrivia.cs

Returns this trivia carrying annotations as well as the ones it already has.

public SyntaxTrivia WithAdditionalAnnotations(params SyntaxAnnotation[] annotations)

Parameters

annotations SyntaxAnnotation[]

Returns

SyntaxTrivia

WithoutAnnotations(SyntaxAnnotation[])

SyntaxTrivia.cs

Returns this trivia without annotations.

public SyntaxTrivia WithoutAnnotations(params SyntaxAnnotation[] annotations)

Parameters

annotations SyntaxAnnotation[]

Returns

SyntaxTrivia

WriteTo(TextWriter)

SyntaxTrivia.cs
public void WriteTo(TextWriter writer)

Parameters

writer TextWriter

Exceptions

ArgumentNullException
writer is null.

Operators

NameDescription
operator ==(SyntaxTrivia, SyntaxTrivia)
operator !=(SyntaxTrivia, SyntaxTrivia)

operator ==(SyntaxTrivia, SyntaxTrivia)

SyntaxTrivia.cs
public static bool operator ==(SyntaxTrivia left, SyntaxTrivia right)

Parameters

left SyntaxTrivia
right SyntaxTrivia

Returns

bool

No documentation is available.

operator !=(SyntaxTrivia, SyntaxTrivia)

SyntaxTrivia.cs
public static bool operator !=(SyntaxTrivia left, SyntaxTrivia right)

Parameters

left SyntaxTrivia
right SyntaxTrivia

Returns

bool

No documentation is available.