Skip to main content

Router

Struct Router 

Source
pub struct Router<State = ()> { /* private fields */ }
Expand description

Router mapping command names to handlers.

Implementations§

Source§

impl<State> Router<State>
where State: Default + Send + Sync + 'static,

Source

pub fn new() -> Self

Create a new router using State::default().

Examples found in repository?
examples/router.rs (line 26)
25pub async fn main() -> Result<()> {
26    let app: Router<()> = Router::new().route("PING", ping);
27    Server::bind("0.0.0.0:6379")
28        .with_hooks(Hooks)
29        .serve(app)
30        .await
31}
Source§

impl<State> Router<State>
where State: Send + Sync + 'static,

Source

pub fn from_state(state: State) -> Self

Create a new router with the provided state.

Examples found in repository?
examples/history.rs (line 45)
40pub async fn main() -> Result<()> {
41    let addr = env::args()
42        .nth(1)
43        .unwrap_or_else(|| "0.0.0.0:6379".to_string());
44
45    let app = Router::from_state(AppState::default())
46        .route("HISTORY", history)
47        .route("COMMAND", history)
48        .route("PING", ping);
49
50    Server::bind(&addr)
51        .with_graceful_shutdown(async {
52            let _ = signal::ctrl_c().await;
53        })
54        .serve(app)
55        .await
56}
Source

pub fn with_state(self, state: State) -> Self

Replace the state while keeping existing routes.

Source

pub fn route<H, Args>(self, command: &'static str, handler: H) -> Self
where H: IntoHandler<State, Args>,

Register a command handler.

The handler must be an async function or Fn that returns a Send + 'static future.

Examples found in repository?
examples/router.rs (line 26)
25pub async fn main() -> Result<()> {
26    let app: Router<()> = Router::new().route("PING", ping);
27    Server::bind("0.0.0.0:6379")
28        .with_hooks(Hooks)
29        .serve(app)
30        .await
31}
More examples
Hide additional examples
examples/history.rs (line 46)
40pub async fn main() -> Result<()> {
41    let addr = env::args()
42        .nth(1)
43        .unwrap_or_else(|| "0.0.0.0:6379".to_string());
44
45    let app = Router::from_state(AppState::default())
46        .route("HISTORY", history)
47        .route("COMMAND", history)
48        .route("PING", ping);
49
50    Server::bind(&addr)
51        .with_graceful_shutdown(async {
52            let _ = signal::ctrl_c().await;
53        })
54        .serve(app)
55        .await
56}

Trait Implementations§

Source§

impl<State> Clone for Router<State>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<State> Default for Router<State>
where State: Default + Send + Sync + 'static,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<State> Freeze for Router<State>

§

impl<State = ()> !RefUnwindSafe for Router<State>

§

impl<State> Send for Router<State>
where State: Sync + Send,

§

impl<State> Sync for Router<State>
where State: Sync + Send,

§

impl<State> Unpin for Router<State>

§

impl<State = ()> !UnwindSafe for Router<State>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.