Struct Argv 

pub struct Argv { /* private fields */ }

A command’s arguments, and the decoder that fills them.

One per connection, reused for the life of the connection. After the first few commands it has the capacity it needs and never allocates again.

Implementations

impl Argv

pub fn new() -> Argv

An empty one.

pub fn with_capacity(n: usize) -> Argv

An empty one with room for n arguments already reserved.

Worth doing at accept time. The first command on a connection is the only one that would otherwise allocate.

pub fn reset(&mut self)

Forgets everything, including any half read command.

The connection calls this if it discards unread bytes for any reason, because the resume state is an offset into a buffer that is about to stop being the same buffer.

pub fn len(&self) -> usize

How many arguments the last complete command had.

pub fn is_empty(&self) -> bool

Whether the last complete command had no arguments.

pub fn arg<'a>(&'a self, buf: &'a [u8], i: usize) -> Option<&'a [u8]>

Argument i, or None if there are fewer than that many.

buf must be the same buffer that was decoded and must not have been drained since.

pub fn args<'a>(&'a self, buf: &'a [u8]) -> impl Iterator<Item = &'a [u8]>

Every argument in order.

pub fn decode( &mut self, buf: &[u8], limits: &Limits, ) -> Result<Step, ProtocolError>

Reads one command from the front of buf.

Errors

Any ProtocolError. Redis closes the connection after one of these and so should the caller: a protocol error means the two ends no longer agree on where the next frame starts, and there is no recovering from that by reading further.

Trait Implementations

impl Debug for Argv

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Argv

fn default() -> Argv

Returns the “default value” for a type.