mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-23 15:51:06 +01:00
align descriptions
This commit is contained in:
Rob Ede
parent
446c92c3d0
commit
07c5176bd0
12
README.md
12
README.md
@ -11,13 +11,13 @@
|
||||
|
||||
| Crate | | |
|
||||
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| [actix-cors] | [](https://crates.io/crates/actix-cors) [](https://deps.rs/crate/actix-cors/0.6.1) | Cross-origin resource sharing (CORS) for actix-web applications. |
|
||||
| [actix-identity] | [](https://crates.io/crates/actix-identity) [](https://deps.rs/crate/actix-identity/0.4.0) | Identity service for actix-web framework. |
|
||||
| [actix-cors] | [](https://crates.io/crates/actix-cors) [](https://deps.rs/crate/actix-cors/0.6.1) | Cross-Origin Resource Sharing (CORS) controls. |
|
||||
| [actix-identity] | [](https://crates.io/crates/actix-identity) [](https://deps.rs/crate/actix-identity/0.4.0) | Identity management. |
|
||||
| [actix-limitation] | [](https://crates.io/crates/actix-limitation) [](https://deps.rs/crate/actix-limitation/0.3.0) | Rate-limiting using a fixed window counter for arbitrary keys, backed by Redis. |
|
||||
| [actix-protobuf] | [](https://crates.io/crates/actix-protobuf) [](https://deps.rs/crate/actix-protobuf/0.8.0) | Protobuf support for actix-web framework. |
|
||||
| [actix-redis] | [](https://crates.io/crates/actix-redis) [](https://deps.rs/crate/actix-redis/0.12.0) | Redis integration for actix framework. |
|
||||
| [actix-session] | [](https://crates.io/crates/actix-session) [](https://deps.rs/crate/actix-session/0.7.0) | Session for actix-web framework. |
|
||||
| [actix-web-httpauth] | [](https://crates.io/crates/actix-web-httpauth) [](https://deps.rs/crate/actix-web-httpauth/0.8.0) | HTTP authentication schemes for actix-web. |
|
||||
| [actix-protobuf] | [](https://crates.io/crates/actix-protobuf) [](https://deps.rs/crate/actix-protobuf/0.8.0) | Protobuf payload extractor. |
|
||||
| [actix-redis] | [](https://crates.io/crates/actix-redis) [](https://deps.rs/crate/actix-redis/0.12.0) | Actor-based Redis client. |
|
||||
| [actix-session] | [](https://crates.io/crates/actix-session) [](https://deps.rs/crate/actix-session/0.7.0) | Session management. |
|
||||
| [actix-web-httpauth] | [](https://crates.io/crates/actix-web-httpauth) [](https://deps.rs/crate/actix-web-httpauth/0.8.0) | HTTP authentication schemes. |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-cors
|
||||
|
||||
> Cross-origin resource sharing (CORS) for Actix Web.
|
||||
> Cross-Origin Resource Sharing (CORS) controls for Actix Web.
|
||||
|
||||
[](https://crates.io/crates/actix-cors)
|
||||
[](https://docs.rs/actix-cors/0.6.1)
|
||||
|
||||
@ -5,7 +5,7 @@ authors = [
|
||||
"Nikolay Kim <fafhrd91@gmail.com>",
|
||||
"Luca Palmieri <rust@lpalmieri.com>",
|
||||
]
|
||||
description = "Identity service for Actix Web"
|
||||
description = "Identity management for Actix Web"
|
||||
keywords = ["actix", "auth", "identity", "web", "security"]
|
||||
homepage = "https://actix.rs"
|
||||
repository = "https://github.com/actix/actix-extras.git"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-identity
|
||||
|
||||
> Identity service for actix-web framework.
|
||||
> Identity management for Actix Web.
|
||||
|
||||
[](https://crates.io/crates/actix-identity)
|
||||
[](https://docs.rs/actix-identity/0.5.2)
|
||||
@ -9,5 +9,5 @@
|
||||
|
||||
## Documentation & community resources
|
||||
|
||||
* [API Documentation](https://docs.rs/actix-identity)
|
||||
* Minimum Supported Rust Version (MSRV): 1.57
|
||||
- [API Documentation](https://docs.rs/actix-identity)
|
||||
- Minimum Supported Rust Version (MSRV): 1.57
|
||||
|
||||
@ -6,7 +6,7 @@ authors = [
|
||||
"kingxsp <jin.hb.zh@outlook.com>",
|
||||
"Yuki Okushi <huyuumi.dev@gmail.com>",
|
||||
]
|
||||
description = "Protobuf support for Actix Web"
|
||||
description = "Protobuf payload extractor for Actix Web"
|
||||
keywords = ["actix", "web", "protobuf", "protocol", "rpc"]
|
||||
homepage = "https://actix.rs"
|
||||
repository = "https://github.com/actix/actix-extras.git"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-protobuf
|
||||
|
||||
> Protobuf support for Actix Web.
|
||||
> Protobuf payload extractor for Actix Web.
|
||||
|
||||
[](https://crates.io/crates/actix-protobuf)
|
||||
[](https://docs.rs/actix-protobuf/0.8.0)
|
||||
@ -23,6 +23,7 @@ use actix_web::*;
|
||||
pub struct MyObj {
|
||||
#[prost(int32, tag = "1")]
|
||||
pub number: i32,
|
||||
|
||||
#[prost(string, tag = "2")]
|
||||
pub name: String,
|
||||
}
|
||||
@ -33,7 +34,7 @@ async fn index(msg: ProtoBuf<MyObj>) -> Result<HttpResponse> {
|
||||
}
|
||||
```
|
||||
|
||||
See [here](https://github.com/actix/actix-extras/tree/master/actix-protobuf/examples/prost-example) for the complete example.
|
||||
See [here](https://github.com/actix/examples/tree/master/protobuf) for the complete example.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
//! Protobuf payload extractor for Actix Web.
|
||||
|
||||
#![forbid(unsafe_code)]
|
||||
#![deny(rust_2018_idioms, nonstandard_style)]
|
||||
#![warn(future_incompatible)]
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
name = "actix-redis"
|
||||
version = "0.12.0"
|
||||
authors = ["Nikolay Kim <fafhrd91@gmail.com>"]
|
||||
description = "Redis integration for Actix"
|
||||
description = "Actor-based Redis client"
|
||||
license = "MIT OR Apache-2.0"
|
||||
keywords = ["actix", "redis", "async"]
|
||||
homepage = "https://actix.rs"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-redis
|
||||
|
||||
> Redis integration for Actix.
|
||||
> Actor-based Redis client.
|
||||
|
||||
[](https://crates.io/crates/actix-redis)
|
||||
[](https://docs.rs/actix-redis/0.12.0)
|
||||
|
||||
@ -4,27 +4,26 @@
|
||||
#![deny(rust_2018_idioms, nonstandard_style)]
|
||||
#![warn(future_incompatible)]
|
||||
|
||||
mod redis;
|
||||
use derive_more::{Display, Error, From};
|
||||
pub use redis::{Command, RedisActor};
|
||||
pub use redis_async::{error::Error as RespError, resp::RespValue, resp_array};
|
||||
|
||||
mod redis;
|
||||
pub use self::redis::{Command, RedisActor};
|
||||
|
||||
/// General purpose `actix-redis` error.
|
||||
#[derive(Debug, Display, Error, From)]
|
||||
pub enum Error {
|
||||
#[display(fmt = "Redis error {}", _0)]
|
||||
#[display(fmt = "Redis error: {}", _0)]
|
||||
Redis(redis_async::error::Error),
|
||||
/// Receiving message during reconnecting
|
||||
|
||||
/// Receiving message during reconnecting.
|
||||
#[display(fmt = "Redis: Not connected")]
|
||||
NotConnected,
|
||||
/// Cancel all waters when connection get dropped
|
||||
|
||||
/// Cancel all waiters when connection is dropped.
|
||||
#[display(fmt = "Redis: Disconnected")]
|
||||
Disconnected,
|
||||
}
|
||||
|
||||
#[cfg(feature = "web")]
|
||||
impl actix_web::ResponseError for Error {}
|
||||
|
||||
// re-export
|
||||
pub use redis_async::error::Error as RespError;
|
||||
pub use redis_async::resp::RespValue;
|
||||
pub use redis_async::resp_array;
|
||||
|
||||
@ -1,22 +1,24 @@
|
||||
use std::collections::VecDeque;
|
||||
use std::io;
|
||||
use std::{collections::VecDeque, io};
|
||||
|
||||
use actix::prelude::*;
|
||||
use actix_rt::net::TcpStream;
|
||||
use actix_service::boxed::{self, BoxService};
|
||||
use actix_tls::connect::{ConnectError, ConnectInfo, Connection, ConnectorService};
|
||||
use backoff::backoff::Backoff;
|
||||
use backoff::ExponentialBackoff;
|
||||
use backoff::{backoff::Backoff, ExponentialBackoff};
|
||||
use log::{error, info, warn};
|
||||
use redis_async::error::Error as RespError;
|
||||
use redis_async::resp::{RespCodec, RespValue};
|
||||
use tokio::io::{split, WriteHalf};
|
||||
use tokio::sync::oneshot;
|
||||
use redis_async::{
|
||||
error::Error as RespError,
|
||||
resp::{RespCodec, RespValue},
|
||||
};
|
||||
use tokio::{
|
||||
io::{split, WriteHalf},
|
||||
sync::oneshot,
|
||||
};
|
||||
use tokio_util::codec::FramedRead;
|
||||
|
||||
use crate::Error;
|
||||
|
||||
/// Command for send data to Redis
|
||||
/// Command for sending data to Redis.
|
||||
#[derive(Debug)]
|
||||
pub struct Command(pub RespValue);
|
||||
|
||||
@ -24,7 +26,7 @@ impl Message for Command {
|
||||
type Result = Result<RespValue, Error>;
|
||||
}
|
||||
|
||||
/// Redis communication actor
|
||||
/// Redis communication actor.
|
||||
pub struct RedisActor {
|
||||
addr: String,
|
||||
connector: BoxService<ConnectInfo<String>, Connection<String, TcpStream>, ConnectError>,
|
||||
|
||||
@ -5,7 +5,7 @@ authors = [
|
||||
"Nikolay Kim <fafhrd91@gmail.com>",
|
||||
"Luca Palmieri <rust@lpalmieri.com>",
|
||||
]
|
||||
description = "Session management for Actix Web"
|
||||
description = "Session management for Actix We"
|
||||
keywords = ["http", "web", "framework", "async", "session"]
|
||||
homepage = "https://actix.rs"
|
||||
repository = "https://github.com/actix/actix-extras.git"
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-session
|
||||
|
||||
> Session management for Actix Web applications.
|
||||
> Session management for Actix Web.
|
||||
|
||||
[](https://crates.io/crates/actix-session)
|
||||
[](https://docs.rs/actix-session/0.7.0)
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# actix-web-httpauth
|
||||
|
||||
> HTTP authentication schemes for [actix-web](https://github.com/actix/actix-web).
|
||||
> HTTP authentication schemes for [Actix Web](https://actix.rs).
|
||||
|
||||
[](https://crates.io/crates/actix-web-httpauth)
|
||||
[](https://docs.rs/actix-web-httpauth/0.8.0)
|
||||
@ -13,6 +13,7 @@
|
||||
- Minimum Supported Rust Version (MSRV): 1.57
|
||||
|
||||
## Features
|
||||
|
||||
- Typed [Authorization] and [WWW-Authenticate] headers
|
||||
- [Extractors] for authorization headers
|
||||
- [Middleware] for easier authorization checking
|
||||
@ -20,10 +21,10 @@
|
||||
All supported schemas can be used in both middleware and request handlers.
|
||||
|
||||
## Supported Schemes
|
||||
|
||||
- [HTTP Basic](https://tools.ietf.org/html/rfc7617)
|
||||
- [OAuth Bearer](https://tools.ietf.org/html/rfc6750)
|
||||
|
||||
|
||||
<!-- LINKS -->
|
||||
|
||||
[Authorization]: https://docs.rs/actix-web-httpauth/*/actix_web_httpauth/headers/authorization/index.html
|
||||
|
||||
Loading…
Reference in New Issue
Block a user