Struct ntex_redis::SubscriptionClient

pub struct SubscriptionClient<U: Command + PubSubCommand> { /* private fields */ }

Redis pubsub client to receive push messages

Implementations

impl<U: Command + PubSubCommand> SubscriptionClient<U>

pub fn into_client(self) -> SimpleClient

Get client back. Don’t forget reset connection!

use ntex_redis::{cmd, RedisConnector};

#[ntex::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let redis = RedisConnector::new("127.0.0.1:6379").connect_simple().await?;
    
    let subscriber = redis.subscribe(cmd::Subscribe(vec!["test"]))?;
    // do some work

    // go back to normal client
    let redis = subscriber.into_client();

    // and reset connection, client may receive pending subscription messages instead of valid RESET response
    if let Err(e) = redis.exec(cmd::Reset()).await {
        println!("Error on reset connection: {}", e);      
    };

    Ok(())
}

pub fn send<T: Command + PubSubCommand>(
    &self,
    cmd: T
) -> Result<(), CommandError>

Send redis subscribe/unsubscribe command

pub async fn recv(&self) -> Option<Result<U::Output, CommandError>>

Attempt to pull out the next value of this stream.

pub fn poll_recv(
    &self,
    cx: &mut Context<'_>
) -> Poll<Option<Result<U::Output, CommandError>>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the payload is exhausted.

Trait Implementations

impl<U: Command + PubSubCommand> Stream for SubscriptionClient<U>

type Item = Result<<U as Command>::Output, CommandError>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.