Class SyntaxPieceRecord

Namespace

Hi.MachiningSteps

Assembly

HiMech.dll

Internal Use Only. The record of one executed SyntaxPiece as the result recording takes it: the snapshot of the piece's sentence and the piece's parse result as compact UTF-8 JSON. Taken on SyntaxPieceRan, on the player's thread. The snapshot is the one interned for the piece (Of(ISentenceCarrier)), the same object the step records built from the piece carry: the reference under which the recorder hands the piece its id. The JSON is the frozen bytes of a frozen piece, wrapped and not copied, or the live graph serialized at the call with CompactNanOptions, the freeze's encoding – the content of that moment: the pipeline may still write a piece until the next piece's first act entry, so a record taken before that boundary and the piece's frozen bytes agree byte for byte only from it on. A piece without a parse result has an empty CompactUtf8Json and HasJson false.

public sealed class SyntaxPieceRecord

Inheritance

object

SyntaxPieceRecord

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DuplicateUtil.TryDuplicate<TSelf>(TSelf, params object[])

InvokeUtil.SelfInvoke<TSrc>(TSrc, Action<TSrc>)

InvokeUtil.SelfInvoke<TSrc, TDst>(TSrc, Func<TSrc, TDst>)

ColorUtil.GetGloomyColor(object, double, double)

KindNameUtil.KindName(object)

NameUtil.GetSelectionName(object)

StringUtil.GetPropertyStringIfToStringNotOverloaded(object, bool, bool)

LockUtil.Lock(object)

Constructors

SyntaxPieceRecord(SentenceSnapshot, ReadOnlyMemory<byte>, bool)

Initializes a record from its parts, which it keeps as they are given: the sampling is Of(SyntaxPiece)'s. For a reader that rebuilds the record from a store.

public SyntaxPieceRecord(SentenceSnapshot sentence, ReadOnlyMemory<byte> compactUtf8Json, bool hasJson)

Parameters

sentence SentenceSnapshot

The snapshot of the piece's sentence; not null.

compactUtf8Json ReadOnlyMemory<byte>

The parse result as compact UTF-8 JSON; empty when there is none.

hasJson bool

Whether the piece had a parse result.

Exceptions

ArgumentNullException

sentence is null.

Properties

CompactUtf8Json

The piece's parse result as compact UTF-8 JSON (NaN and the infinities as quoted literals, explicit nulls kept): a frozen piece's own bytes, a live piece's serialized at the call. Empty when the piece has no parse result (HasJson).

public ReadOnlyMemory<byte> CompactUtf8Json { get; }

Property Value

ReadOnlyMemory<byte>

HasJson

Whether the piece had a parse result at all: false for a piece without a JsonObject, whose CompactUtf8Json is empty.

public bool HasJson { get; }

Property Value

bool

Sentence

The snapshot of the piece's sentence, the one interned for the piece: the record's key. Never null.

public SentenceSnapshot Sentence { get; }

Property Value

SentenceSnapshot

SentenceIndex

The sentence's execution-order index, through Sentence. A diagnostic column: the key is Sentence.

public int SentenceIndex { get; }

Property Value

int

Methods

Of(SyntaxPiece)

Internal Use Only. The record of piece as it is now: the snapshot interned for the piece and the piece's parse result as compact UTF-8 JSON. Serializing a live piece another thread is writing can throw out of the node tree; the recorder, which samples off the pipeline's thread, catches. A null piece – the HardNc runner's – is refused: the recorder skips it.

public static SyntaxPieceRecord Of(SyntaxPiece piece)

Parameters

piece SyntaxPiece

The piece; not null.

Returns

SyntaxPieceRecord

The record.

Exceptions

ArgumentNullException

piece is null.