PubSubSink in redis::aio - Rust
Description: The sink part of a split async Pubsub.

Skip to main content

## PubSubSink

# Struct PubSubSink

Source

    pub struct PubSubSink { /* private fields */ }

Available on crate feature `aio` only.
Expand description

The sink part of a split async Pubsub.

The sink is used to subscribe and unsubscribe from channels. The stream part is independent from the sink, and dropping the sink doesn’t cause the stream part to stop working. The sink isn’t independent from the stream - dropping the stream will cause the sink to return errors on requests.

## Implementations§

Source§

### impl PubSubSink

Source

#### pub async fn subscribe( &mut self, channel_name: impl ToRedisArgs, ) -> RedisResult<()>

Subscribes to a new channel(s).

    let client = redis::Client::open("redis://127.0.0.1/")?;
    let (mut sink, _stream) = client.get_async_pubsub().await?.split();
    sink.subscribe("channel_1").await?;
    sink.subscribe(&["channel_2", "channel_3"]).await?;

Source

#### pub async fn unsubscribe( &mut self, channel_name: impl ToRedisArgs, ) -> RedisResult<()>

Unsubscribes from channel(s).

    let client = redis::Client::open("redis://127.0.0.1/")?;
    let (mut sink, _stream) = client.get_async_pubsub().await?.split();
    sink.subscribe(&["channel_1", "channel_2"]).await?;
    sink.unsubscribe(&["channel_1", "channel_2"]).await?;

Source

#### pub async fn psubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> RedisResult<()>

Subscribes to new channel(s) with pattern(s).

    let client = redis::Client::open("redis://127.0.0.1/")?;
    let (mut sink, _stream) = client.get_async_pubsub().await?.split();
    sink.psubscribe("channel*_1").await?;
    sink.psubscribe(&["channel*_2", "channel*_3"]).await?;

Source

#### pub async fn punsubscribe( &mut self, channel_pattern: impl ToRedisArgs, ) -> RedisResult<()>

Unsubscribes from channel pattern(s).

    let client = redis::Client::open("redis://127.0.0.1/")?;
    let (mut sink, _stream) = client.get_async_pubsub().await?.split();
    sink.psubscribe(&["channel_1", "channel_2"]).await?;
    sink.punsubscribe(&["channel_1", "channel_2"]).await?;

Source

#### pub async fn ping_message<T: FromRedisValue>( &mut self, message: impl ToRedisArgs, ) -> RedisResult<T>

Sends a ping with a message to the server

Source

#### pub async fn ping<T: FromRedisValue>(&mut self) -> RedisResult<T>

Sends a ping to the server

## Trait Implementations§

Source§

### impl Clone for PubSubSink

Source§

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

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§

§

### impl Freeze for PubSubSink

§

### impl RefUnwindSafe for PubSubSink

§

### impl Send for PubSubSink

§

### impl Sync for PubSubSink

§

### impl Unpin for PubSubSink

§

### impl UnwindSafe for PubSubSink

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