Struct exonum_api::ApiScope

pub struct ApiScope { /* fields omitted */ }

Exonum API builder for the concrete API scope or, in other words, API access level (public or private).

Endpoints cannot be declared to the builder directly, first you need to indicate the scope the endpoint(s) will belong to.

Methods

impl ApiScope

pub fn new() -> Self

Creates a new instance.

pub fn endpoint<Q, I, R, F, E>(&mut self, name: &str, endpoint: E) -> &mut Self where
    Q: DeserializeOwned + 'static,
    I: Serialize + 'static,
    F: Fn(Q) -> R + 'static + Clone + Send + Sync,
    E: Into<With<Q, I, R, F>>,
    R: Future<Output = Result<I>>, 

Adds the given endpoint handler to the API scope. These endpoints are designed for reading operations.

For now there is only web backend and it has the following requirements:

• Query parameters should be decodable via serde_urlencoded, i.e. from the first_param=value1&second_param=value2 form.
• Response items should be encodable via serde_json crate.

pub fn endpoint_mut<Q, I, R, F, E>(
    &mut self,
    name: &str,
    endpoint: E
) -> &mut Self where
    Q: DeserializeOwned + 'static,
    I: Serialize + 'static,
    F: Fn(Q) -> R + 'static + Clone + Send + Sync,
    E: Into<With<Q, I, R, F>>,
    R: Future<Output = Result<I>>, 

Adds the given mutable endpoint handler to the API scope. These endpoints are designed for modification operations.

For now there is only web backend and it has the following requirements:

• Query parameters should be decodable via serde_json.
• Response items also should be encodable via serde_json crate.

pub fn web_backend(&mut self) -> &mut ApiBuilder

Returns a mutable reference to the underlying web backend.

Trait Implementations

impl Clone for ApiScope

fn clone(&self) -> ApiScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiScope

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

Formats the value using the given formatter.

impl Default for ApiScope

fn default() -> ApiScope

Returns the "default value" for a type.