Struct writium::namespace::Namespace

pub struct Namespace { /* fields omitted */ }

Namespace bind with apis and forms an intermediate layer of API. It self doesn't do a thing but it will.

It's name is used to distinguish with other peer APIs and all the sub-API will not see the namespace name segments in the request. If you want the namespace it self to have some functionalities, you need to create a sub-API and name it &[]. But such design is not recommended because it sometimes will make the API work in a weird way, especially when path variables are involved, i.e. the trailing part of the path is used as a variable.

Methods

impl Namespace

pub fn new(name: &'static [&'static str]) -> Namespace

pub fn with_api<A: Api>(self, api: A) -> Namespace

pub fn bind<A: Api>(&mut self, api: A)

Trait Implementations

impl Clone for Namespace

fn clone(&self) -> Namespace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Api for Namespace

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

fn name(&self) -> &[&str]

Name of API. It identifies an API and allow Writium to route by URL path segments.

fn route(&self, req: &mut Request) -> ApiResult

The route function here will ask every sub-API to make an response in binding order. The collection routing is short-circuiting, i.e., once a sub-API responded, the response is returned and the following it won't check the remaining unchecked sub-apis.