Documentation

A row's values, each read whole into bytes of its own, for the token-level interface (TRow). A typed row decoder never builds one.

How many columns the row has.

The value at a column, counted from 0; error past the last.

The length of the value at a column, or -1 for NULL.

The row's values, in column order.

A row from its values.

How a column's values are delimited, chosen once from its metadata. A value with no delimiter of its own (a fixed width, or no value at all) keeps its Cell here, so that every row shares it.

What a value's delimiter said: NULL, a known length, or a PLP value whose total length may or may not be known. The payload still follows.

The value's declared length, if it has one that fits an Int64.

How a column's value is delimited in a ROW: as valueShape says, with a text pointer and timestamp in front of a legacy text, ntext or image value.

How a RETURNVALUE's value is delimited: as a column's, except that a legacy text, ntext or image value has no text pointer in front of it.

Read a value's delimiter. Each form has its own way to say NULL.

The value's payload as it arrives, in pieces. A PLP value's chunk headers are read here and never appear in the stream.

A value for a consumer: read whole (Right) if it is at most this many bytes, given the allocation bound of wholeValueBytes and the limit, or else its payload as it arrives (Left, as valueStream). A PLP value whose total isn't known (xml, and json) is read a chunk at a time until it ends within the limit; once a chunk would take it past, the stream starts with the chunks already read, so at most the limit is ever held. A whole value is Owned unless it lay in one payload, and a drain that takes over while it is read gives DiscardedValue.

A value read whole: NULL, present, or discarded because a drain took over the response while the value was being assembled.

Read all of a value: a slice if it lies in the buffer, otherwise one buffer of its own.

Read all of a value into bytes of its own, as an output parameter's value is kept. A value discarded by a drain comes back as empty bytes, which only the drain sees.

Pass over a value's payload.

Fold over the pieces of a value's payload: one piece for a sized value, or a PLP value's chunks, with the chunk headers read here. The step must consume exactly the length it is given, whether it reads, collects or skips.

A row's token byte, and an NBCROW's null bitmap. Empty means a ROW, where each delimiter says for itself whether its value is NULL.

Whether the bitmap marks this column NULL, in which case it has no bytes at all.

Read one column's delimiter, including its NBCROW null bit.

Read past these columns of a row, given as their indexes and shapes.