Class ParseResult

Namespace

Celeritas.Core

Assembly

Celeritas.dll

Result of parsing music notation.

public sealed record ParseResult : IEquatable<ParseResult>

Inheritance

object

ParseResult

Implements

IEquatable<ParseResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Directives

Notation directives (tempo, section, dynamics, etc.) found in the input.

public NotationDirective[] Directives { get; init; }

Property Value

NotationDirective[]

Errors

Parse errors collected during lexing/parsing. Always empty on a result handed to a caller: parsing throws ArgumentException as soon as an error is recorded, so there is nothing here to inspect — catch the exception instead.

public IReadOnlyList<string> Errors { get; init; }

Property Value

IReadOnlyList<string>

Notes

The parsed note events.

public NoteEvent[] Notes { get; init; }

Property Value

NoteEvent[]

TimeSignature

The time signature found in the input, or null if none was specified.

public TimeSignature? TimeSignature { get; init; }

Property Value

TimeSignature?