Skip to main content

Args

Struct Args 

Source
pub struct Args<'a> { /* private fields */ }
Expand description

One command’s arguments, borrowed from the connection’s read buffer.

Index zero is the command name, the same as Redis’s argv, so an argument index in this file matches the argument index in Redis’s source and in its error messages.

Implementations§

Source§

impl<'a> Args<'a>

Source

pub fn new(argv: &'a Argv, buf: &'a [u8]) -> Args<'a>

The arguments of the command argv last decoded out of buf.

Source

pub fn len(&self) -> usize

How many arguments there are, counting the command name.

Source

pub fn is_empty(&self) -> bool

Whether there is not even a command name.

Source

pub fn get(&self, i: usize) -> &'a [u8]

Argument i, or an empty slice past the end.

Past the end is empty rather than a panic because every caller has already been through the arity check, so an index past the end is a bug in the arity table rather than something a client can cause, and a wrong answer in the reply is a better way to find that bug than a process that stops answering.

Source

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

Argument i, or None past the end.

Source

pub fn name(&self) -> &'a [u8]

The command name, which is argument zero.

Source

pub fn int(&self, i: usize) -> Result<i64>

Argument i as an integer, with Redis’s message when it is not one.

§Errors

Code::Invalid when the argument is not an integer in i64.

Source

pub fn float(&self, i: usize) -> Result<f64>

Argument i as a float, with Redis’s message when it is not one.

§Errors

Code::Invalid when the argument is not a float, which includes NaN.

Trait Implementations§

Source§

impl<'a> Clone for Args<'a>

Source§

fn clone(&self) -> Args<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for Args<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Args<'a>

§

impl<'a> RefUnwindSafe for Args<'a>

§

impl<'a> Send for Args<'a>

§

impl<'a> Sync for Args<'a>

§

impl<'a> Unpin for Args<'a>

§

impl<'a> UnsafeUnpin for Args<'a>

§

impl<'a> UnwindSafe for Args<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.