WebService

rama::http::service::web

Struct WebService 

pub struct WebService<State = ()> { /* private fields */ }
Expand description

A basic web service that can be used to serve HTTP requests.

Note that this service boxes all the internal services, so it is not as efficient as it could be. For those locations where you need do not desire the convenience over performance, you can instead use a tuple of (M, S) tuples, where M is a matcher and S is a service, e.g. ((MethodMatcher::GET, service_a), (MethodMatcher::POST, service_b), service_fallback).

Implementations§

§

impl<State> WebService<State>
where State: Send + Sync + Clone + 'static,

pub fn with_state<T>(self, state: T) -> WebService<T>
where State: Send + Sync + Clone + 'static,

pub fn get<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a GET route to the web service, using the given service.

pub fn post<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a POST route to the web service, using the given service.

pub fn put<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a PUT route to the web service, using the given service.

pub fn delete<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a DELETE route to the web service, using the given service.

pub fn patch<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a PATCH route to the web service, using the given service.

pub fn head<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a HEAD route to the web service, using the given service.

pub fn options<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a OPTIONS route to the web service, using the given service.

pub fn trace<I, T>(self, path: &str, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a TRACE route to the web service, using the given service.

pub fn nest(self, prefix: &str, web_service: WebService) -> WebService<State>

Nest a web service under the given path.

The nested service will receive a request with the path prefix removed.

Note: this sub-webservice is configured with the same State this router has.

pub fn nest_service<I, T>(self, prefix: &str, service: I) -> WebService<State>
where I: IntoEndpointService<T>,

Nest a web service under the given path.

The nested service will receive a request with the path prefix removed.

Warning: This sub-service has no notion of the state this webservice has. If you want to create a nested-service that shares the same state this webservice has, use WebService::nest instead.

pub fn file( self, prefix: &str, path: impl AsRef<Path>, mime: Mime, ) -> WebService<State>

serve the given file under the given path.

pub fn dir(self, prefix: &str, path: impl AsRef<Path>) -> WebService<State>

serve the given directory under the given path.

pub fn dir_with_serve_mode( self, prefix: &str, path: impl AsRef<Path>, mode: DirectoryServeMode, ) -> WebService<State>

serve the given directory under the given path, with a custom serve move.

pub fn dir_embed(self, prefix: &str, dir: Dir<'static>) -> WebService<State>

serve the given embedded directory under the given path.

pub fn dir_embed_with_serve_mode( self, prefix: &str, dir: Dir<'static>, mode: DirectoryServeMode, ) -> WebService<State>

serve the given embedded directory under the given path with a custom serve move.

pub fn on<I, T>( self, matcher: HttpMatcher<Body>, service: I, ) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

add a route to the web service which matches the given matcher, using the given service.

pub fn not_found<I, T>(self, service: I) -> WebService<State>
where I: IntoEndpointServiceWithState<T, State>,

use the given service in case no match could be found.

Trait Implementations§

§

impl<State> Clone for WebService<State>
where State: Clone,

§

fn clone(&self) -> WebService<State>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for WebService

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
§

impl Default for WebService

§

fn default() -> WebService

Returns the “default value” for a type. Read more
§

impl<State> Service<Request> for WebService<State>
where State: Send + Sync + Clone + 'static,

§

type Response = Response

The type of response returned by the service.
§

type Error = Infallible

The type of error returned by the service.
§

async fn serve( &self, req: Request, ) -> Result<<WebService<State> as Service<Request>>::Response, <WebService<State> as Service<Request>>::Error>

Serve a response or error for the given request, using the given context.
§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

impl<State> Freeze for WebService<State>
where State: Freeze,

§

impl<State = ()> !RefUnwindSafe for WebService<State>

§

impl<State> Send for WebService<State>
where State: Send,

§

impl<State> Sync for WebService<State>
where State: Sync,

§

impl<State> Unpin for WebService<State>
where State: Unpin,

§

impl<State = ()> !UnwindSafe for WebService<State>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<S, Body> HttpClientExt for S
where S: Service<Request, Response = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

type ExecuteResponse = Response<Body>

The response type returned by the execute method.
§

type ExecuteError = <S as Service<Request>>::Error

The error type returned by the execute method.
§

fn get( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a GET request to a URL. Read more
§

fn post( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a POST request to a URL. Read more
§

fn put( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PUT request to a URL. Read more
§

fn patch( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a PATCH request to a URL. Read more
§

fn delete( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a DELETE request to a URL. Read more
§

fn head( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a HEAD request to a URL. Read more
§

fn connect( &self, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Convenience method to make a CONNECT request to a URL. Read more
§

fn request( &self, method: Method, url: impl IntoUrl, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>

Start building a Request with the Method and Url. Read more
§

fn build_from_request<RequestBody>( &self, request: Request<RequestBody>, ) -> RequestBuilder<'_, S, <S as HttpClientExt>::ExecuteResponse>
where RequestBody: Into<Body>,

Start building a Request, using the given Request. Read more
§

fn execute( &self, request: Request, ) -> impl Future<Output = Result<<S as HttpClientExt>::ExecuteResponse, <S as HttpClientExt>::ExecuteError>>

Executes a Request. Read more
§

impl<S, Body> HttpClientWebSocketExt<Body> for S
where S: Service<Request, Response = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

§

fn websocket( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder] to be used to establish a WebSocket connection over http/1.1.
§

fn websocket_h2( &self, url: impl IntoUrl, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>

Create a new WebSocketRequestBuilder to be used to establish a WebSocket connection over h2.
§

fn websocket_with_request<RequestBody>( &self, req: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'_, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocketRequestBuilder starting from the given request. Read more
§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<S, R> IntoEndpointService<(R,)> for S
where S: Service<Request, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

§

fn into_endpoint_service( self, ) -> impl Service<Request, Response = Response, Error = Infallible>

convert the type into a rama_core::Service.
§

impl<S, R, State> IntoEndpointServiceWithState<(R,), State> for S
where S: Service<Request, Response = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

§

fn into_endpoint_service_with_state( self, _state: State, ) -> impl Service<Request, Response = Response, Error = Infallible>

convert the type into a rama_core::Service with state.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

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

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

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

§

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

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

§

impl<S, RequestIn, RequestOut> RequestInspector<RequestIn> for S
where S: Service<RequestIn, Response = RequestOut>, RequestIn: Send + 'static, RequestOut: Send + 'static,

§

type Error = <S as Service<RequestIn>>::Error

The type of error returned by the service.
§

type RequestOut = RequestOut

§

fn inspect_request( &self, req: RequestIn, ) -> impl Future<Output = Result<<S as RequestInspector<RequestIn>>::RequestOut, <S as RequestInspector<RequestIn>>::Error>> + Send

Inspect the request, modify it if needed or desired, and return it.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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