Struct redis::aio::PubSub

source · [−]

pub struct PubSub<C = Pin<Box<dyn AsyncStream + Send + Sync>>>(_);

Available on crate feature aio only.

Expand description

Represents a PubSub connection.

Implementations

source

impl<C> PubSub<C> where
C: Unpin + AsyncRead + AsyncWrite + Send,

Subscribes to a new channel.

source

pub async fn psubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

Subscribes to a new channel with a pattern.

source

pub async fn unsubscribe<T: ToRedisArgs>(
&mut self,
channel: T
) -> RedisResult<()>

Unsubscribes from a channel.

source

pub async fn punsubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

Unsubscribes from a channel with a pattern.

source

pub fn on_message(&mut self) -> impl Stream<Item = Msg> + '_

Returns [Stream] of Msgs from this PubSubs subscriptions.

The message itself is still generic and can be converted into an appropriate type through the helper methods on it.

source

pub fn into_on_message(self) -> impl Stream<Item = Msg>

Returns [Stream] of Msgs from this PubSubs subscriptions consuming it.

The message itself is still generic and can be converted into an appropriate type through the helper methods on it. This can be useful in cases where the stream needs to be returned or held by something other

source

pub async fn into_connection(self) -> Connection<C>

Exits from PubSub mode and converts PubSub into Connection.

Auto Trait Implementations

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !RefUnwindSafe for PubSub<C>

impl<C> Send for PubSub<C> where
C: Send,

impl<C> Sync for PubSub<C> where
C: Sync,

impl<C> Unpin for PubSub<C> where
C: Unpin,

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !UnwindSafe for PubSub<C>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

Struct redis::aio::PubSub

Implementations

impl<C> PubSub<C> where
C: Unpin + AsyncRead + AsyncWrite + Send,

pub async fn psubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

pub async fn unsubscribe<T: ToRedisArgs>(
&mut self,
channel: T
) -> RedisResult<()>

pub async fn punsubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

pub fn on_message(&mut self) -> impl Stream<Item = Msg> + '_

pub fn into_on_message(self) -> impl Stream<Item = Msg>

pub async fn into_connection(self) -> Connection<C>

Auto Trait Implementations

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !RefUnwindSafe for PubSub<C>

impl<C> Send for PubSub<C> where
C: Send,

impl<C> Sync for PubSub<C> where
C: Sync,

impl<C> Unpin for PubSub<C> where
C: Unpin,

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !UnwindSafe for PubSub<C>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct redis::aio::PubSub

Implementations

impl<C> PubSub<C> where C: Unpin + AsyncRead + AsyncWrite + Send,

pub async fn subscribe<T: ToRedisArgs>(&mut self, channel: T) -> RedisResult<()>

pub async fn psubscribe<T: ToRedisArgs>( &mut self, pchannel: T) -> RedisResult<()>

pub async fn unsubscribe<T: ToRedisArgs>( &mut self, channel: T) -> RedisResult<()>

pub async fn punsubscribe<T: ToRedisArgs>( &mut self, pchannel: T) -> RedisResult<()>

pub fn on_message(&mut self) -> impl Stream<Item = Msg> + '_

pub fn into_on_message(self) -> impl Stream<Item = Msg>

pub async fn into_connection(self) -> Connection<C>

Auto Trait Implementations

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !RefUnwindSafe for PubSub<C>

impl<C> Send for PubSub<C> where C: Send,

impl<C> Sync for PubSub<C> where C: Sync,

impl<C> Unpin for PubSub<C> where C: Unpin,

impl<C = Pin<Box<dyn AsyncStream + Send + Sync + 'static, Global>>> !UnwindSafe for PubSub<C>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<C> PubSub<C> where
C: Unpin + AsyncRead + AsyncWrite + Send,

pub async fn psubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

pub async fn unsubscribe<T: ToRedisArgs>(
&mut self,
channel: T
) -> RedisResult<()>

pub async fn punsubscribe<T: ToRedisArgs>(
&mut self,
pchannel: T
) -> RedisResult<()>

impl<C> Send for PubSub<C> where
C: Send,

impl<C> Sync for PubSub<C> where
C: Sync,

impl<C> Unpin for PubSub<C> where
C: Unpin,

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

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

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

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

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

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

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

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