Struct splinter::rest_api::Resource

pub struct Resource { /* fields omitted */ }

Resource represents a RESTful endpoint.

use splinter::rest_api::{Resource, Method};
use actix_web::HttpResponse;
use futures::IntoFuture;

Resource::build("/index")
    .add_method(Method::Get, |r, p| {
        Box::new(
            HttpResponse::Ok()
                .body("Hello, World")
                .into_future()
        )
    });

Methods

impl Resource

pub fn new<F>(method: Method, route: &str, handle: F) -> Self where
    F: Fn(HttpRequest, Payload) -> Box<dyn Future<Item = HttpResponse, Error = ActixError>> + Send + Sync + 'static, 

Deprecated:

Please use the build and add_method methods instead

pub fn build(route: &str) -> Self

pub fn add_method<F>(self, method: Method, handle: F) -> Self where
    F: Fn(HttpRequest, Payload) -> Box<dyn Future<Item = HttpResponse, Error = ActixError>> + Send + Sync + 'static, 

pub fn add_request_guard<RG>(self, guard: RG) -> Self where
    RG: RequestGuard + Clone + 'static, 

Adds a RequestGuard to the given Resource.

This guard applies to all methods defined for this resource.

Example

use splinter::rest_api::{Resource, Method, Continuation};
use actix_web::{HttpRequest, HttpResponse};
use futures::IntoFuture;

Resource::build("/index")
    .add_request_guard(|r: &HttpRequest| {
        if !r.headers().contains_key("GuardFlag") {
            Continuation::terminate(
                HttpResponse::BadRequest().finish().into_future(),
            )
        } else {
            Continuation::Continue
        }
    })
    .add_method(Method::Get, |r, p| {
        Box::new(
            HttpResponse::Ok()
                .body("Hello, World")
                .into_future()
        )
    });

Trait Implementations

impl Clone for Resource

fn clone(&self) -> Resource

Returns a copy of the value.

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

Performs copy-assignment from source.