Skip to main content

Streams

Struct Streams 

Source
pub struct Streams { /* private fields */ }
Expand description

Provides atomic stream update operations

Implementations§

Source§

impl Streams

Source

pub fn new(iii: III) -> Self

Create a new Streams instance with the given iii

Source

pub async fn update( &self, key: impl Into<String>, ops: Vec<UpdateOp>, ) -> Result<UpdateResult, IIIError>

Perform an atomic update on a stream key

All operations are applied atomically - either all succeed or none are applied.

§Arguments
  • key - The stream key to update (format: “stream_name::group_id::item_id”)
  • ops - List of operations to apply atomically
§Returns

Returns UpdateResult containing the old and new values

§Example
let result = streams.update(
    "orders::user-123::order-456",
    vec![
        UpdateOp::increment("total", 100),
        UpdateOp::set("status", "processing".into()),
    ],
).await?;
Source

pub async fn increment( &self, key: impl Into<String>, field: impl Into<String>, by: i64, ) -> Result<UpdateResult, IIIError>

Atomically increment a numeric field

Convenience method for a single increment operation.

§Example
streams.increment("counters::daily::page-views", "count", 1).await?;
Source

pub async fn decrement( &self, key: impl Into<String>, field: impl Into<String>, by: i64, ) -> Result<UpdateResult, IIIError>

Atomically decrement a numeric field

Convenience method for a single decrement operation.

Source

pub async fn set_field( &self, key: impl Into<String>, field: impl Into<String>, value: impl Into<Value>, ) -> Result<UpdateResult, IIIError>

Atomically set a field value

Convenience method for a single set operation.

§Example
streams.set_field("users::active::user-1", "status", "online".into()).await?;
Source

pub async fn remove_field( &self, key: impl Into<String>, field: impl Into<String>, ) -> Result<UpdateResult, IIIError>

Atomically remove a field

Convenience method for a single remove operation.

Source

pub async fn merge( &self, key: impl Into<String>, value: impl Into<Value>, ) -> Result<UpdateResult, IIIError>

Atomically merge an object into the existing value

Convenience method for a single merge operation.

§Example
streams.merge(
    "settings::user-1::preferences",
    serde_json::json!({"theme": "dark", "language": "en"}),
).await?;

Trait Implementations§

Source§

impl Clone for Streams

Source§

fn clone(&self) -> Streams

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

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

Source§

type Output = T

Should always be Self
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.
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