Struct kvarn::extensions::RuleSet

source ·
pub struct RuleSet<R> { /* private fields */ }
Expand description

A set of rules applicable to certain paths. See the note at Self::empty on how paths are matched.

Implementations§

source§

impl RuleSet<AllowList>

source

pub fn check_origin( &self, origin: &Uri, uri_path: &str ) -> Option<(MethodAllowList<'_>, &[HeaderName], Duration)>

Check if the (cross-origin) request’s origin Uri is allowed by the CORS rules.

See CorsAllowList::check for info about the return types.

source

pub fn check_cors_request<T>( &self, request: &Request<T> ) -> Option<(MethodAllowList<'_>, &[HeaderName], Duration)>

Check if the Request::headers and Request::uri is allowed with this ruleset.

This will not check for errors in access-control-request-headers.

Use this over Self::check_origin because this checks for same_origin requests.

See CorsAllowList::check for info about the return types.

source§

impl<R> RuleSet<R>

source

pub fn empty() -> Self

Creates a new ruleset without any rules.

source

pub fn add(self, path: impl AsRef<str>, rule: impl Into<R>) -> Self

Adds rule to path.

To use this with Host::vary, use Self::add_mut, which this uses internally.

By default, path will only match requests with the exact path. This can be changed by appending * to the end of the path, which will then check if the request path start with path.

source

pub fn add_mut( &mut self, path: impl AsRef<str>, rule: impl Into<R> ) -> &mut Self

Same as Self::add but operating on a mutable reference.

source

pub fn arc(self) -> Arc<Self>

Puts self in a Arc.

Useful for e.g. adding a Cors ruleset with Extensions::with_cors.

source

pub fn get(&self, uri_path: &str) -> Option<&R>

Gets the rule (if any) at uri_path.

For info about how this is matched, see Self::add.

source§

impl RuleSet<Settings>

source

pub fn rules_from_request<'a, T>( &'a self, request: &Request<T> ) -> Cow<'a, Settings>

Gets the Settings from the ruleset using the path of request.

Trait Implementations§

source§

impl<R: Clone> Clone for RuleSet<R>

source§

fn clone(&self) -> RuleSet<R>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<R: Debug> Debug for RuleSet<R>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for RuleSet<R>

§

impl<R> RefUnwindSafe for RuleSet<R>
where R: RefUnwindSafe,

§

impl<R> Send for RuleSet<R>
where R: Send,

§

impl<R> Sync for RuleSet<R>
where R: Sync,

§

impl<R> Unpin for RuleSet<R>
where R: Unpin,

§

impl<R> UnwindSafe for RuleSet<R>
where R: UnwindSafe,

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
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> From<T> for T

source§

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

§

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

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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

§

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

§

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