Cors

rama::http::layer::cors

Struct Cors 

pub struct Cors<S> { /* private fields */ }
Available on crate feature http only.
Expand description

Middleware which adds headers for CORS.

See the module docs for an example.

Implementations§

§

impl<S> Cors<S>

pub fn new(inner: S) -> Cors<S>

Create a new Cors.

See CorsLayer::new for more details.

pub fn permissive(inner: S) -> Cors<S>

A permissive configuration.

See CorsLayer::permissive for more details.

pub fn very_permissive(inner: S) -> Cors<S>

A very permissive configuration.

See CorsLayer::very_permissive for more details.

pub fn get_ref(&self) -> &S

Gets a reference to the underlying service.

pub fn into_inner(self) -> S

Consumes self, returning the underlying service.

pub fn try_with_allow_credentials(self) -> Result<Cors<S>, OpaqueError>

Always set the Access-Control-Allow-Credentials header.

§Errors

Errors in case any of the other CORS headers which support the wildcard value have been set to use it.

pub fn try_set_allow_credentials(&mut self) -> Result<&mut Cors<S>, OpaqueError>

Always set the Access-Control-Allow-Credentials header.

§Errors

Errors in case any of the other CORS headers which support the wildcard value have been set to use it.

pub fn with_allow_credentials_if( self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> Cors<S>

Set the Access-Control-Allow-Credentials header if predicate is satisfied.

pub fn set_allow_credentials_if( &mut self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> &mut Cors<S>

Set the Access-Control-Allow-Credentials header if predicate is satisfied.

pub fn try_with_allow_headers( self, headers: AccessControlAllowHeaders, ) -> Result<Cors<S>, OpaqueError>

Set the value of the Access-Control-Allow-Headers header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn try_set_allow_headers( &mut self, headers: AccessControlAllowHeaders, ) -> Result<&mut Cors<S>, OpaqueError>

Set the value of the Access-Control-Allow-Headers header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn with_max_age(self, header: AccessControlMaxAge) -> Cors<S>

Set the value of the Access-Control-Max-Age header.

By default the header will not be set which disables caching and will require a preflight call for all requests.

Note that each browser has a maximum internal value that takes precedence when the Access-Control-Max-Age is greater. For more details see mdn.

If you need more flexibility, you can use supply a function which can dynamically decide the optional max-age based on the origin and other parts of each preflight request.

pub fn set_max_age(&mut self, header: AccessControlMaxAge) -> &mut Cors<S>

Set the value of the Access-Control-Max-Age header.

By default the header will not be set which disables caching and will require a preflight call for all requests.

Note that each browser has a maximum internal value that takes precedence when the Access-Control-Max-Age is greater. For more details see mdn.

If you need more flexibility, you can use supply a function which can dynamically decide the optional max-age based on the origin and other parts of each preflight request.

pub fn with_max_age_if( self, predicate: impl Fn(&HeaderValue, &Parts) -> Option<Seconds> + Send + Sync + 'static, ) -> Cors<S>

Set the Access-Control-Max-Age header if predicate is satisfied.

See Self::with_max_age and Self::set_max_age for more information.

pub fn set_max_age_if( &mut self, predicate: impl Fn(&HeaderValue, &Parts) -> Option<Seconds> + Send + Sync + 'static, ) -> &mut Cors<S>

Set the Access-Control-Max-Age header if predicate is satisfied.

See Self::with_max_age and Self::set_max_age for more information.

pub fn try_with_allow_methods( self, methods: AccessControlAllowMethods, ) -> Result<Cors<S>, OpaqueError>

Set the value of the Access-Control-Allow-Methods header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn try_set_allow_methods( &mut self, methods: AccessControlAllowMethods, ) -> Result<&mut Cors<S>, OpaqueError>

Set the value of the Access-Control-Allow-Methods header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn try_with_allow_origin_any(self) -> Result<Cors<S>, OpaqueError>

Only set the Access-Control-Allow-Origin header with the wildcard value (*).

§Errors

Errors in case credentials are allowed.

pub fn try_set_allow_origin_any(&mut self) -> Result<&mut Cors<S>, OpaqueError>

Only set the Access-Control-Allow-Origin header with the wildcard value (*).

§Errors

Errors in case credentials are allowed.

pub fn with_allow_origin_if_null(self) -> Cors<S>

Only set the Access-Control-Allow-Origin header with the “null” value when that is the origin.

Note: The value null should not be used. It may seem safe to return Access-Control-Allow-Origin: "null"; however, the origin of resources that use a non-hierarchical scheme (such as data: or file:) and sandboxed documents is serialized as null. Many browsers will grant such documents access to a response with an Access-Control-Allow-Origin: null header, and any origin can create a hostile document with a null origin. Therefore, the null value for the Access-Control-Allow-Origin header should be avoided

pub fn set_allow_origin_if_null(&mut self) -> &mut Cors<S>

Only set the Access-Control-Allow-Origin header with the “null” value when that is the origin.

Note: The value null should not be used. It may seem safe to return Access-Control-Allow-Origin: "null"; however, the origin of resources that use a non-hierarchical scheme (such as data: or file:) and sandboxed documents is serialized as null. Many browsers will grant such documents access to a response with an Access-Control-Allow-Origin: null header, and any origin can create a hostile document with a null origin. Therefore, the null value for the Access-Control-Allow-Origin header should be avoided

pub fn with_allow_origin_if( self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> Cors<S>

Set the value of the Access-Control-Allow-Origin header if the predicate satisfied.

pub fn set_allow_origin_if( &mut self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> &mut Cors<S>

Set the value of the Access-Control-Allow-Origin header if the predicate satisfied.

pub fn try_with_expose_headers( self, headers: AccessControlExposeHeaders, ) -> Result<Cors<S>, OpaqueError>

Set the value of the Access-Control-Expose-Headers header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn try_set_expose_headers( &mut self, headers: AccessControlExposeHeaders, ) -> Result<&mut Cors<S>, OpaqueError>

Set the value of the Access-Control-Expose-Headers header.

§Errors

Errors in case credentials are allowed and the given header contains the wildcard value (*).

pub fn with_allow_private_network(self) -> Cors<S>

Always set the Access-Control-Allow-Private-Network header.

pub fn set_allow_private_network(&mut self) -> &mut Cors<S>

Always set the Access-Control-Allow-Private-Network header.

pub fn with_allow_private_network_if( self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> Cors<S>

Set the Access-Control-Allow-Private-Network header if predicate is satisfied.

pub fn set_allow_private_network_if( &mut self, predicate: impl Fn(&HeaderValue, &Parts) -> bool + Send + Sync + 'static, ) -> &mut Cors<S>

Set the Access-Control-Allow-Private-Network header if predicate is satisfied.

Trait Implementations§

§

impl<S> Clone for Cors<S>
where S: Clone,

§

fn clone(&self) -> Cors<S>

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
§

impl<S> Debug for Cors<S>
where S: Debug,

§

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

Formats the value using the given formatter. Read more
§

impl<S, ReqBody, ResBody> Service<Request<ReqBody>> for Cors<S>
where S: Service<Request<ReqBody>, Output = Response<ResBody>>, ReqBody: Send + 'static, ResBody: Default + Send + 'static,

§

type Output = <S as Service<Request<ReqBody>>>::Output

The type of the output returned by the service.
§

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

The type of error returned by the service.
§

async fn serve( &self, req: Request<ReqBody>, ) -> Result<<Cors<S> as Service<Request<ReqBody>>>::Output, <Cors<S> as Service<Request<ReqBody>>>::Error>

Serve a an output or error for the given input, using the given context.
§

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

§

impl<S> !Freeze for Cors<S>

§

impl<S> !RefUnwindSafe for Cors<S>

§

impl<S> Send for Cors<S>
where S: Send,

§

impl<S> Sync for Cors<S>
where S: Sync,

§

impl<S> Unpin for Cors<S>
where S: Unpin,

§

impl<S> !UnwindSafe for Cors<S>

Blanket Implementations§

§

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

§

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>

§

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> CloneToUninit for T
where T: Clone,

§

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
§

impl<S, Input, Connection> ConnectorService<Input> for S
where S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>, <S as Service<Input>>::Error: Into<Box<dyn Error + Sync + Send>>, Connection: Send + ExtensionsMut,

§

type Connection = Connection

Connection returned by the ConnectorService
§

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

Error returned in case of connection / setup failure
§

fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, <S as ConnectorService<Input>>::Error>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival.
§

impl<T> From<T> for T

§

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, Output = 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, Output = 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
§

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.

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, Output = R, Error = Infallible>, R: IntoResponse + Send + Sync + 'static,

§

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

convert the type into a rama_core::Service.
§

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

§

fn into_endpoint_service_with_state( self, _state: State, ) -> impl Service<Request, Output = 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>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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