[−][src]Struct dropshot::ApiEndpoint
ApiEndpoint represents a single API endpoint associated with an ApiDescription. It has a handler, HTTP method (e.g. GET, POST), and a path-- provided explicitly--as well as parameters and a description which can be inferred from function parameter types and doc comments (respectively).
Fields
operation_id: String
handler: Box<dyn RouteHandler>
method: Method
path: String
parameters: Vec<ApiEndpointParameter>
response: ApiEndpointResponse
description: Option<String>
Implementations
impl<'a> ApiEndpoint
[src]
pub fn new<HandlerType, FuncParams, ResponseType>(
operation_id: String,
handler: HandlerType,
method: Method,
path: &'a str
) -> Self where
HandlerType: HttpHandlerFunc<FuncParams, ResponseType>,
FuncParams: Extractor + 'static,
ResponseType: HttpResponse + Send + Sync + 'static,
[src]
operation_id: String,
handler: HandlerType,
method: Method,
path: &'a str
) -> Self where
HandlerType: HttpHandlerFunc<FuncParams, ResponseType>,
FuncParams: Extractor + 'static,
ResponseType: HttpResponse + Send + Sync + 'static,
pub fn description<T: ToString>(self, description: T) -> Self
[src]
pub fn tag<T: ToString>(self, tag: T) -> Self
[src]
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for ApiEndpoint
impl Send for ApiEndpoint
impl Sync for ApiEndpoint
impl Unpin for ApiEndpoint
impl !UnwindSafe for ApiEndpoint
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
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>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
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>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,