Struct exonum_rust_runtime::api::Deprecated

pub struct Deprecated<Q, I, R, F> {
    pub handler: F,
    pub discontinued_on: Option<DateTime<Utc>>,
    pub description: Option<String>,
    // some fields omitted
}

Wrapper over an endpoint handler, which marks it as deprecated.

Fields

handler: F

Underlying API handler.

discontinued_on: Option<DateTime<Utc>>

Optional endpoint expiration date.

description: Option<String>

Optional additional note.

Methods

impl<Q, I, R, F> Deprecated<Q, I, R, F>

pub fn new(handler: F) -> Deprecated<Q, I, R, F>

Creates a new Deprecated object.

pub fn with_date(self, discontinued_on: DateTime<Utc>) -> Deprecated<Q, I, R, F>

Adds an expiration date for endpoint.

pub fn with_description<S>(self, description: S) -> Deprecated<Q, I, R, F> where
    S: Into<String>, 

Adds a description note to the warning, e.g. link to the new API documentation.

pub fn with_different_handler<F1>(self, handler: F1) -> Deprecated<Q, I, R, F1>

Replaces the used handler with a new one.

Trait Implementations

impl<Q, I, R, F> Clone for Deprecated<Q, I, R, F> where
    F: Clone,
    I: Clone,
    Q: Clone,
    R: Clone, 

fn clone(&self) -> Deprecated<Q, I, R, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Q, I, R, F> Debug for Deprecated<Q, I, R, F> where
    F: Debug,
    I: Debug,
    Q: Debug,
    R: Debug, 

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

Formats the value using the given formatter.

impl<Q, I, F> From<F> for Deprecated<Q, I, Result<I, Error>, F> where
    F: Fn(Q) -> Result<I, Error>, 

fn from(handler: F) -> Deprecated<Q, I, Result<I, Error>, F>

Performs the conversion.

impl<Q, I, F> From<F> for Deprecated<Q, I, Box<dyn Future<Item = I, Error = Error> + 'static>, F> where
    F: Fn(Q) -> Box<dyn Future<Item = I, Error = Error> + 'static>, 

fn from(
    handler: F
) -> Deprecated<Q, I, Box<dyn Future<Item = I, Error = Error> + 'static>, F>

Performs the conversion.