Skip to main content

SubApi

typeway_server::serves

Struct SubApi

pub struct SubApi<A: ApiSpec, H> { /* private fields */ }

Expand description

A wrapper that pairs a sub-API with its handler tuple.

Allows composing APIs larger than 22 endpoints by nesting sub-APIs.

§Example

type UsersAPI = (GetEndpoint<UsersPath, Vec<User>>, PostEndpoint<UsersPath, CreateUser, User>);
type OrdersAPI = (GetEndpoint<OrdersPath, Vec<Order>>,);
type FullAPI = (UsersAPI, OrdersAPI);

Server::<FullAPI>::new((
    SubApi::<UsersAPI, _>::new((bind!(list_users), bind!(create_user))),
    SubApi::<OrdersAPI, _>::new((bind!(list_orders),)),
))

A wrapper that pairs a sub-API type with its handler tuple for nested API composition.

Implementations§

impl<A: ApiSpec, H> SubApi<A, H>

pub fn new(handlers: H) -> Self

impl<A: ApiSpec, H: Serves<A>> SubApi<A, H>

pub fn register_into(self, router: &mut Router)

Register all handlers from this sub-API into the router.

Auto Trait Implementations§

impl<A, H> Freeze for SubApi<A, H>
where H: Freeze,

impl<A, H> RefUnwindSafe for SubApi<A, H>
where H: RefUnwindSafe, A: RefUnwindSafe,

impl<A, H> Send for SubApi<A, H>
where H: Send, A: Send,

impl<A, H> Sync for SubApi<A, H>
where H: Sync, A: Sync,

impl<A, H> Unpin for SubApi<A, H>
where H: Unpin, A: Unpin,

impl<A, H> UnsafeUnpin for SubApi<A, H>
where H: UnsafeUnpin,

impl<A, H> UnwindSafe for SubApi<A, H>
where H: UnwindSafe, A: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<B, C, R, H> Serves<VersionedApi<B, C, R>> for H
where R: ApiSpec, H: Serves<R>,

fn register(self, router: &mut Router)

Register all handlers into the router.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> IsEndpoint<T> for T