Struct hitbox_actix::RedisBackend

pub struct RedisBackend { /* fields omitted */ }

Redis cache backend based on redis-rs crate.

This actor provides redis as storage Backend for hitbox. Its use one MultiplexedConnection for asynchronous network interaction.

Implementations

impl RedisBackend

pub async fn new() -> Result<RedisBackend, Error>

Create new backend instance with default settings.

Examples

use hitbox_redis::RedisBackend;

#[actix_rt::main]
async fn main() {
    let backend = RedisBackend::new().await;
}

pub fn builder() -> RedisBackendBuilder

Creates new RedisBackend builder with default settings.

Trait Implementations

impl Actor for RedisBackend

Implementation actix Actor trait for Redis cache backend.

type Context = Context<RedisBackend>

Actor execution context type

pub fn started(&mut self, &mut <RedisBackend as Actor>::Context)

Called when an actor gets polled the first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

fn start_in_arbiter<F>(arb: &Arbiter, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self + Send + 'static, 

Start new actor in arbiter’s thread.

fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl Backend for RedisBackend

type Actor = RedisBackend

Type of backend actor bound.

type Context = Context<RedisBackend>

Type for backend Actor context.

impl Handler<Delete> for RedisBackend

Implementation of Actix Handler for Delete message.

type Result = Pin<Box<dyn Future<Output = Result<DeleteStatus, BackendError>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: Delete,
    &mut <RedisBackend as Actor>::Context
) -> <RedisBackend as Handler<Delete>>::Result

This method is called for every message received by this actor.

impl Handler<Get> for RedisBackend

Implementation of Actix Handler for Get message.

type Result = Pin<Box<dyn Future<Output = Result<Option<Vec<u8, Global>>, BackendError>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: Get,
    &mut <RedisBackend as Actor>::Context
) -> <RedisBackend as Handler<Get>>::Result

This method is called for every message received by this actor.

impl Handler<Lock> for RedisBackend

Implementation of Actix Handler for Lock message.

type Result = Pin<Box<dyn Future<Output = Result<LockStatus, BackendError>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: Lock,
    &mut <RedisBackend as Actor>::Context
) -> <RedisBackend as Handler<Lock>>::Result

This method is called for every message received by this actor.

impl Handler<Set> for RedisBackend

Implementation of Actix Handler for Set message.

type Result = Pin<Box<dyn Future<Output = Result<String, BackendError>> + 'static, Global>>

The type of value that this handler will return.

pub fn handle(
    &mut self,
    msg: Set,
    &mut <RedisBackend as Actor>::Context
) -> <RedisBackend as Handler<Set>>::Result

This method is called for every message received by this actor.