SyntaxTriviaList Struct

The trivia on one side of a token.

Implements

Nested types

NameDescription
SyntaxTriviaList.EnumeratorWalks a SyntaxTriviaList without allocating.

Constructors

NameDescription
SyntaxTriviaList(IEnumerable<SyntaxTrivia>)Creates a detached list holding trivia.

SyntaxTriviaList(IEnumerable<SyntaxTrivia>)

SyntaxTriviaList.cs

Creates a detached list holding trivia.

public SyntaxTriviaList(IEnumerable<SyntaxTrivia> trivia)

Parameters

trivia IEnumerable<SyntaxTrivia>

Exceptions

ArgumentNullException
trivia is null.

Properties

NameDescription
Count
FullSpan
Span
public int Count { get; }

Property value

int

No documentation is available.

public TextSpan FullSpan { get; }

Property value

TextSpan

No documentation is available.

public TextSpan Span { get; }

Property value

TextSpan

No documentation is available.

Indexers

NameDescription
this[int]
public SyntaxTrivia this[int index] { get; }

Parameters

index int

Property value

SyntaxTrivia

No documentation is available.

Methods

NameDescription
Add(SyntaxTrivia)Returns a detached list with trivia appended.
AddRange(IEnumerable<SyntaxTrivia>)Returns a detached list with trivia appended.
Any()
Create(ReadOnlySpan<SyntaxTrivia>)Creates a detached list holding trivia.
Equals(SyntaxTriviaList)
Equals(object?)
First()
FirstOrDefault()
GetEnumerator()
GetHashCode()
IndexOf(SyntaxTrivia)Returns the position of trivia in this list, or -1.
Insert(int, SyntaxTrivia)Returns a detached list with trivia inserted at index.
InsertRange(int, IEnumerable<SyntaxTrivia>)Returns a detached list with trivia inserted at index.
Last()
LastOrDefault()
Remove(SyntaxTrivia)Returns a detached list without trivia, or this list when it does not contain it.
RemoveAt(int)Returns a detached list without the trivia at index.
Replace(SyntaxTrivia, SyntaxTrivia)Returns a detached list with newTrivia in place of triviaInList.
System.Collections.Generic.IEnumerable<Meziantou.Framework.Language.SyntaxTrivia>.GetEnumerator()
System.Collections.IEnumerable.GetEnumerator()
ToFullString()
ToString()

Add(SyntaxTrivia)

SyntaxTriviaList.cs

Returns a detached list with trivia appended.

public SyntaxTriviaList Add(SyntaxTrivia trivia)

Parameters

trivia SyntaxTrivia

Returns

SyntaxTriviaList

AddRange(IEnumerable<SyntaxTrivia>)

SyntaxTriviaList.cs

Returns a detached list with trivia appended.

public SyntaxTriviaList AddRange(IEnumerable<SyntaxTrivia> trivia)
public bool Any()

Returns

bool

No documentation is available.

Create(ReadOnlySpan<SyntaxTrivia>)

SyntaxTriviaList.cs

Creates a detached list holding trivia.

public static SyntaxTriviaList Create(ReadOnlySpan<SyntaxTrivia> trivia)

Parameters

trivia ReadOnlySpan<SyntaxTrivia>

Returns

SyntaxTriviaList

Remarks

This is what a collection expression targeting SyntaxTriviaList builds its list with.

Equals overloads

Equals(SyntaxTriviaList)

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

bool

No documentation is available.

Equals(object?)

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

bool

No documentation is available.

public SyntaxTrivia First()

No documentation is available.

FirstOrDefault()

SyntaxTriviaList.cs
public SyntaxTrivia FirstOrDefault()

No documentation is available.

GetEnumerator()

SyntaxTriviaList.cs
public SyntaxTriviaList.Enumerator GetEnumerator()

No documentation is available.

GetHashCode()

SyntaxTriviaList.cs
public override int GetHashCode()

Returns

int

No documentation is available.

IndexOf(SyntaxTrivia)

SyntaxTriviaList.cs

Returns the position of trivia in this list, or -1.

public int IndexOf(SyntaxTrivia trivia)

Parameters

trivia SyntaxTrivia

Returns

int

Remarks

Trivia is matched by which entry it is, not by the immutable trivium behind it: a run of spaces is interned, so two entries holding the same text are usually the same trivium and would both answer with the first.

Insert(int, SyntaxTrivia)

SyntaxTriviaList.cs

Returns a detached list with trivia inserted at index.

public SyntaxTriviaList Insert(int index, SyntaxTrivia trivia)

Parameters

index int
trivia SyntaxTrivia

Returns

SyntaxTriviaList

InsertRange(int, IEnumerable<SyntaxTrivia>)

SyntaxTriviaList.cs

Returns a detached list with trivia inserted at index.

public SyntaxTriviaList InsertRange(int index, IEnumerable<SyntaxTrivia> trivia)

Parameters

index int
trivia IEnumerable<SyntaxTrivia>

Returns

SyntaxTriviaList

public SyntaxTrivia Last()

No documentation is available.

LastOrDefault()

SyntaxTriviaList.cs
public SyntaxTrivia LastOrDefault()

No documentation is available.

Remove(SyntaxTrivia)

SyntaxTriviaList.cs

Returns a detached list without trivia, or this list when it does not contain it.

public SyntaxTriviaList Remove(SyntaxTrivia trivia)

Parameters

trivia SyntaxTrivia

Returns

SyntaxTriviaList

RemoveAt(int)

SyntaxTriviaList.cs

Returns a detached list without the trivia at index.

public SyntaxTriviaList RemoveAt(int index)

Parameters

index int

Returns

SyntaxTriviaList

Replace(SyntaxTrivia, SyntaxTrivia)

SyntaxTriviaList.cs

Returns a detached list with newTrivia in place of triviaInList.

public SyntaxTriviaList Replace(SyntaxTrivia triviaInList, SyntaxTrivia newTrivia)

Parameters

triviaInList SyntaxTrivia
newTrivia SyntaxTrivia

Returns

SyntaxTriviaList

Exceptions

ArgumentException
triviaInList is not in this list.

System.Collections.Generic.IEnumerable<Meziantou.Framework.Language.SyntaxTrivia>.GetEnumerator()

SyntaxTriviaList.cs

No documentation is available.

System.Collections.IEnumerable.GetEnumerator()

SyntaxTriviaList.cs
IEnumerator IEnumerable.GetEnumerator()

No documentation is available.

ToFullString()

SyntaxTriviaList.cs
public string ToFullString()

Returns

string

No documentation is available.

public override string ToString()

Returns

string

No documentation is available.

Operators

NameDescription
operator ==(SyntaxTriviaList, SyntaxTriviaList)
operator !=(SyntaxTriviaList, SyntaxTriviaList)

operator ==(SyntaxTriviaList, SyntaxTriviaList)

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

Parameters

left SyntaxTriviaList
right SyntaxTriviaList

Returns

bool

No documentation is available.

operator !=(SyntaxTriviaList, SyntaxTriviaList)

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

Parameters

left SyntaxTriviaList
right SyntaxTriviaList

Returns

bool

No documentation is available.