Skip to main content

CommandArg

Struct CommandArg 

Source
pub struct CommandArg(/* private fields */);
Expand description

An owned, binary-safe Redis command argument.

Redis keys, values, fields, and members are byte strings, not UTF-8 text. CommandArg lets typed command builders accept those bytes without giving up the convenient string call sites used by most applications.

Owned String, Vec<u8>, and Bytes inputs reuse their allocation (or shared storage). Borrowed strings, byte slices, and arrays are copied once because command values must be owned and may outlive the caller. Cloning a CommandArg is cheap because Bytes uses shared storage.

§Examples

use bytes::Bytes;
use redis_tower_commands::CommandArg;

let text = CommandArg::from("users:42");
let invalid_utf8 = CommandArg::from(&b"key:\xff"[..]);
let shared = CommandArg::from(Bytes::from_static(b"payload"));

assert_eq!(text.as_bytes(), b"users:42");
assert_eq!(invalid_utf8.as_bytes(), b"key:\xff");
assert_eq!(shared.as_bytes(), b"payload");

Implementations§

Source§

impl CommandArg

Source

pub fn copy_from_slice(value: &[u8]) -> CommandArg

Construct an argument by copying a borrowed byte slice.

Source

pub const fn from_static(value: &'static [u8]) -> CommandArg

Construct an argument backed by static bytes without copying.

Source

pub fn as_bytes(&self) -> &[u8] ⓘ

Borrow the exact bytes that will be sent to Redis.

Source

pub fn into_bytes(self) -> Bytes

Consume the argument and return its shared byte storage.

Source

pub fn len(&self) -> usize

Return the argument length in bytes.

Source

pub fn is_empty(&self) -> bool

Return true when the argument contains no bytes.

Trait Implementations§

Source§

impl AsRef<[u8]> for CommandArg

Source§

fn as_ref(&self) -> &[u8] ⓘ

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for CommandArg

Source§

fn clone(&self) -> CommandArg

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 Debug for CommandArg

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandArg

Source§

fn default() -> CommandArg

Returns the “default value” for a type. Read more
Source§

impl Eq for CommandArg

Source§

impl From<&&[u8]> for CommandArg

Source§

fn from(value: &&[u8]) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&&str> for CommandArg

Source§

fn from(value: &&str) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&Bytes> for CommandArg

Source§

fn from(value: &Bytes) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&CommandArg> for CommandArg

Source§

fn from(value: &CommandArg) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&String> for CommandArg

Source§

fn from(value: &String) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&Vec<u8>> for CommandArg

Source§

fn from(value: &Vec<u8>) -> CommandArg

Converts to this type from the input type.
Source§

impl<const N: usize> From<&[u8; N]> for CommandArg

Source§

fn from(value: &[u8; N]) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&[u8]> for CommandArg

Source§

fn from(value: &[u8]) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&mut str> for CommandArg

Source§

fn from(value: &mut str) -> CommandArg

Converts to this type from the input type.
Source§

impl From<&str> for CommandArg

Source§

fn from(value: &str) -> CommandArg

Converts to this type from the input type.
Source§

impl From<Box<str>> for CommandArg

Source§

fn from(value: Box<str>) -> CommandArg

Converts to this type from the input type.
Source§

impl From<Bytes> for CommandArg

Source§

fn from(value: Bytes) -> CommandArg

Converts to this type from the input type.
Source§

impl<'a> From<Cow<'a, [u8]>> for CommandArg

Source§

fn from(value: Cow<'a, [u8]>) -> CommandArg

Converts to this type from the input type.
Source§

impl<'a> From<Cow<'a, str>> for CommandArg

Source§

fn from(value: Cow<'a, str>) -> CommandArg

Converts to this type from the input type.
Source§

impl From<String> for CommandArg

Source§

fn from(value: String) -> CommandArg

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for CommandArg

Source§

fn from(value: Vec<u8>) -> CommandArg

Converts to this type from the input type.
Source§

impl<const N: usize> From<[u8; N]> for CommandArg

Source§

fn from(value: [u8; N]) -> CommandArg

Converts to this type from the input type.
Source§

impl From<char> for CommandArg

Source§

fn from(value: char) -> CommandArg

Converts to this type from the input type.
Source§

impl Hash for CommandArg

Source§

fn hash<__H>(&self, state: &mut __H)
where __H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for CommandArg

Source§

fn cmp(&self, other: &CommandArg) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for CommandArg

Source§

fn eq(&self, other: &CommandArg) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl PartialOrd for CommandArg

Source§

fn partial_cmp(&self, other: &CommandArg) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for CommandArg

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToHex for T
where T: AsRef<[u8]>,

Source§

fn encode_hex<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca)
Source§

fn encode_hex_upper<U>(&self) -> U
where U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA)
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more