Struct redis_async::client::pubsub::PubsubConnection
source · [−]pub struct PubsubConnection { /* private fields */ }Expand description
A shareable reference to subscribe to PUBSUB topics
Implementations
sourceimpl PubsubConnection
impl PubsubConnection
sourcepub async fn subscribe(&self, topic: &str) -> Result<PubsubStream, Error>
pub async fn subscribe(&self, topic: &str) -> Result<PubsubStream, Error>
Subscribes to a particular PUBSUB topic.
Returns a future that resolves to a Stream that contains all the messages published on
that particular topic.
The resolved stream will end with redis_async::error::Error::EndOfStream if the
underlying connection is lost for unexpected reasons. In this situation, clients should
subscribe to re-subscribe; the underlying connect will automatically reconnect. However,
clients should be aware that resubscriptions will only succeed if the underlying connection
has re-established, so multiple calls to subscribe may be required.
pub async fn psubscribe(&self, topic: &str) -> Result<PubsubStream, Error>
sourcepub fn unsubscribe<T: Into<String>>(&self, topic: T)
pub fn unsubscribe<T: Into<String>>(&self, topic: T)
Tells the client to unsubscribe from a particular topic. This will return immediately, the
actual unsubscription will be confirmed when the stream returned from subscribe ends.
pub fn punsubscribe<T: Into<String>>(&self, topic: T)
Trait Implementations
sourceimpl Clone for PubsubConnection
impl Clone for PubsubConnection
sourcefn clone(&self) -> PubsubConnection
fn clone(&self) -> PubsubConnection
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
Auto Trait Implementations
impl !RefUnwindSafe for PubsubConnection
impl Send for PubsubConnection
impl Sync for PubsubConnection
impl Unpin for PubsubConnection
impl !UnwindSafe for PubsubConnection
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more