Command

Command :: # (opaque)

A binary-safe Redis command.

Redis clients send commands as non-empty RESP arrays whose elements are bulk strings. The first element is the command name and the remaining elements are arguments. No quoting, escaping, or UTF-8 conversion is performed by the byte-oriented constructor.

is_eq : _

new : NonEmptyBytes, List(Bytes) -> Command

Construct using a name whose non-empty invariant is already established.

to_parts : Command -> List(List(U8))

Read-only wire arguments, including the validated nonempty command name.

from_bytes : List(U8), List(List(U8)) -> Try(Command, Error)

Construct a command from a byte-valued name and arguments.

from_nonempty_bytes : NonEmptyBytes, List(List(U8)) -> Command

Construct a command whose byte-valued name is non-empty by construction.

Quoted names are validated by NonEmptyBytes.from_quote at compile time.

from_utf8 : Str, List(Str) -> Try(Command, Error)

Construct a command from UTF-8 text.

ping : () -> Command

Construct PING.

ping_with_message : List(U8) -> Command

Construct PING message, preserving arbitrary message bytes.

echo : List(U8) -> Command

Construct binary-safe ECHO message.

encode : Command -> List(U8)

Encode one command using the Redis client wire format.

encode_pipeline : List(Command) -> List(U8)

Encode commands back-to-back for Redis pipelining.

pipeline_size : List(Command), U64 -> Try(U64, [RequestByteLimitExceeded({ limit : U64 })])

Measure before allocating the outbound buffer. Subtract from a remaining budget so even a sum exceeding U64 cannot overflow.

encode_bounded : List(Command), U64 -> Try(List(U8), [RequestByteLimitExceeded({ limit : U64 })])

Encode into one reserved buffer after the complete size check succeeds.

Error : [EmptyCommandName]