StreamId in redis::streams - Rust
Description: Represents a stream `id` and its field/values as a `HashMap` Also contains optional PEL information if the message was fetched with XREADGROUP with a `claim` option

Skip to main content

## StreamId

# Struct StreamId

Source

    pub struct StreamId {
        pub id: String,
        pub map: AHashMap<String, Value>,
        pub milliseconds_elapsed_from_delivery: Option<usize>,
        pub delivered_count: Option<usize>,
    }

Available on crate feature `streams` only.
Expand description

Represents a stream `id` and its field/values as a `HashMap` Also contains optional PEL information if the message was fetched with XREADGROUP with a `claim` option

## Fields§

§`id: String`

The stream `id` (entry ID) of this particular message.

§`map: AHashMap<String, Value>`

All fields in this message, associated with their respective values.

§`milliseconds_elapsed_from_delivery: Option<usize>`

The number of milliseconds that elapsed since the last time this entry was delivered to a consumer.

§`delivered_count: Option<usize>`

The number of times this entry was delivered.

## Implementations§

Source§

### impl StreamId

Source

#### pub fn get<T: FromRedisValue>(&self, key: &str) -> Option<T>

Fetches value of a given field and converts it to the specified type.

Source

#### pub fn contains_key(&self, key: &str) -> bool

Does the message contain a particular field?

Source

#### pub fn len(&self) -> usize

Returns how many field/value pairs exist in this message.

Source

#### pub fn is_empty(&self) -> bool

Returns true if there are no field/value pairs in this message.

## Trait Implementations§

Source§

### impl Clone for StreamId

Source§

#### fn clone(&self) -> StreamId

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for StreamId

Source§

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

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

### impl Default for StreamId

Source§

#### fn default() -> StreamId

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

### impl PartialEq for StreamId

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl StructuralPartialEq for StreamId

## Auto Trait Implementations§

§

### impl Freeze for StreamId

§

### impl RefUnwindSafe for StreamId

§

### impl Send for StreamId

§

### impl Sync for StreamId

§

### impl Unpin for StreamId

§

### impl UnwindSafe for StreamId

## 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> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

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

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

#### 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.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
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 = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

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

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### 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
§

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

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

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T