Struct RuleSet

pub struct RuleSet<R> { /* private fields */ }

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

Implementations

impl RuleSet<AllowList>

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.

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.

impl<R> RuleSet<R>

pub fn empty() -> Self

Creates a new ruleset without any rules.

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.

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.

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

Puts self in a Arc.

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

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.

impl RuleSet<Settings>

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.