Documentation

An in-memory value (Nothing is NULL), lazy bytes read as they are sent, or a source run as it is sent. A request holding either of the last two can be sent only once; a query builds a new request each time it is sent.

The constructors are public so that libraries can inspect and build values.

Where a streamed parameter's bytes come from. It is a function of what consumes the stream, so a resource can be scoped to exactly the send, for example with withBinaryFile. A bare stream couldn't scope one, and a second send would run it from wherever it had got to.

Use an existing stream. Holding on to the stream yourself keeps whatever it has produced alive, and a stream can be sent only once.

A stream made by this action when sending starts. For a resource to release after the send, use the Source constructor.

Why a value can't be sent in this type, if it can't. A value sent as it is read has no length ahead of time, so only a PLP type can carry it.

Whether the value is sent as it is read, so it isn't in memory to check.

Write a parameter's value, which has been checked already (paramValueProblem). A lazy or streamed value is written as a PLP value of unknown total length, in chunks of at most 8000 bytes, with the source's empty chunks left out; a UTF-16 source must end on a code unit boundary.

writeParamValue, with what comes before the value, such as the parameter's header, in the same Builder. A BYTE-length scalar is poked straight after the header rather than composed with it; every other value runs the writer once for both.