actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-28 01:32:57 +01:00
Code Issues Releases Wiki Activity

added some documentation

Browse Source
This commit is contained in:
Alexander Andreev 2018-02-17 21:37:30 +03:00
parent 28b50a3755
commit 14cfcb7e87
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/lib.rs
View File

@ -1,3 +1,12 @@
//! Redis integration for Actix framework.
//!
//! ## Documentation
//! * [API Documentation (Development)](http://actix.github.io/actix-redis/actix_redis/)
//! * [API Documentation (Releases)](https://docs.rs/actix-redis/)
//! * [Chat on gitter](https://gitter.im/actix/actix)
//! * Cargo package: [actix-redis](https://crates.io/crates/actix-redis)
//! * Minimum supported Rust version: 1.21 or later
//!
extern crate actix;
extern crate backoff;
extern crate futures;
@ -31,7 +40,7 @@ mod session;
#[cfg(feature="web")]
pub use session::RedisSessionBackend;
/// General purpose actix redis error
#[derive(Fail, Debug)]
pub enum Error {
#[fail(display="Redis error {}", _0)]

2
src/redis.rs
View File

@ -17,6 +17,7 @@ use redis_async::resp::{RespCodec, RespValue};
use Error;
/// Command for send data to Redis
#[derive(Debug)]
pub struct Command(pub RespValue);
@ -33,6 +34,7 @@ pub struct RedisActor {
}
impl RedisActor {
/// Start new `Supervisor` with `RedisActor`.
pub fn start<S: Into<String>>(addr: S) -> Addr<Unsync, RedisActor> {
let addr = addr.into();