Struct Timer

pub struct Timer { /* private fields */ }

The Timer structure is the default Context.

Implementations

impl Timer

pub fn background() -> Self

Create a default, independent timer with no time duration limit.

pub fn todo() -> Self

Create a default, independent timer with no time duration limit.

pub fn with_timeout(timeout: Duration) -> Self

Specify the maximum execution duration for the Timer.

pub fn in_seconds(secs: u64) -> Self

Specify the maximum execution duration for the Timer, in seconds.

pub fn in_milliseconds(millis: u64) -> Self

Specify the maximum execution duration for the Timer, in seconds.

Trait Implementations

impl Clone for Timer

fn clone(&self) -> Timer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Context for Timer

type SubContext = Timer

fn timer(&self) -> Timer

return the basic Timer.

fn name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Name> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Available on crate feature name only.

return the name of this context

fn deadline<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Instant>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

return the deadline time::Instant of this context. return None when this context doesn’t have deadline.

fn cancel<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

cancel this context, then cancel all its childs.

fn is_cancelled<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

check whether this context is cancelled or not.

fn is_timeout<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

check whether this context is timeout or not.

fn spawn<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Self> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

spawn a new child context.

fn spawn_with_timeout<'life0, 'async_trait>( &'life0 self, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Self> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

spawn a new child context, with a new timeout parameter.

fn handle<'a, 'life0, 'async_trait, Fut, Output>( &'life0 self, fut: Fut, ) -> Pin<Box<dyn Future<Output = Result<Output>> + Send + 'async_trait>>

where Fut: Future<Output = Output> + Send + 'a + 'async_trait, Output: 'async_trait, Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

handle a future

fn error<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

check whether there is an Error in context.

fn spawn_in_seconds<'life0, 'async_trait>( &'life0 self, secs: u64, ) -> Pin<Box<dyn Future<Output = Self::SubContext> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

spawn a new child context, with a new timeout parameter in seconds.

fn spawn_in_milliseconds<'life0, 'async_trait>( &'life0 self, millis: u64, ) -> Pin<Box<dyn Future<Output = Self::SubContext> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

spawn a new child context, with a new timeout parameter in milliseconds.

fn handle_result<'a, 'life0, 'async_trait, Fut, T, E>( &'life0 self, fut: Fut, ) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send + 'async_trait>>

where Fut: Future<Output = Result<T, E>> + Send + 'a + 'async_trait, E: From<Error> + 'async_trait, T: 'async_trait, Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

handle a future that returns Result<T, E>.

impl Debug for Timer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromRequest for Timer

Available on crate feature actix-web-from-request only.

type Error = Error

The associated error which can be returned.

type Future = Pin<Box<dyn Future<Output = Result<Timer, <Timer as FromRequest>::Error>>>>

Future that resolves to a Self.

fn from_request(_: &HttpRequest, _: &mut Payload) -> Self::Future

Create a Self from request parts asynchronously.

fn extract(req: &HttpRequest) -> Self::Future

Create a Self from request head asynchronously.