Struct axum::routing::MethodFilter
source · [−]pub struct MethodFilter { /* private fields */ }
Expand description
A filter that matches one or more HTTP methods.
Implementations
sourceimpl MethodFilter
impl MethodFilter
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for MethodFilter
impl Binary for MethodFilter
sourceimpl BitAnd<MethodFilter> for MethodFilter
impl BitAnd<MethodFilter> for MethodFilter
type Output = MethodFilter
type Output = MethodFilter
&
operator.sourceimpl BitAndAssign<MethodFilter> for MethodFilter
impl BitAndAssign<MethodFilter> for MethodFilter
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<MethodFilter> for MethodFilter
impl BitOr<MethodFilter> for MethodFilter
sourcefn bitor(self, other: MethodFilter) -> Self
fn bitor(self, other: MethodFilter) -> Self
Returns the union of the two sets of flags.
type Output = MethodFilter
type Output = MethodFilter
|
operator.sourceimpl BitOrAssign<MethodFilter> for MethodFilter
impl BitOrAssign<MethodFilter> for MethodFilter
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<MethodFilter> for MethodFilter
impl BitXor<MethodFilter> for MethodFilter
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = MethodFilter
type Output = MethodFilter
^
operator.sourceimpl BitXorAssign<MethodFilter> for MethodFilter
impl BitXorAssign<MethodFilter> for MethodFilter
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for MethodFilter
impl Clone for MethodFilter
sourcefn clone(&self) -> MethodFilter
fn clone(&self) -> MethodFilter
1.0.0 · sourceconst fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for MethodFilter
impl Debug for MethodFilter
sourceimpl Extend<MethodFilter> for MethodFilter
impl Extend<MethodFilter> for MethodFilter
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<MethodFilter> for MethodFilter
impl FromIterator<MethodFilter> for MethodFilter
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for MethodFilter
impl Hash for MethodFilter
sourceimpl LowerHex for MethodFilter
impl LowerHex for MethodFilter
sourceimpl Not for MethodFilter
impl Not for MethodFilter
type Output = MethodFilter
type Output = MethodFilter
!
operator.sourceimpl Octal for MethodFilter
impl Octal for MethodFilter
sourceimpl Ord for MethodFilter
impl Ord for MethodFilter
sourcefn cmp(&self, other: &MethodFilter) -> Ordering
fn cmp(&self, other: &MethodFilter) -> Ordering
1.21.0 · sourceconst fn max(self, other: Self) -> Self
const fn max(self, other: Self) -> Self
1.21.0 · sourceconst fn min(self, other: Self) -> Self
const fn min(self, other: Self) -> Self
1.50.0 · sourceconst fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
const fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: PartialOrd<Self>,
sourceimpl PartialEq<MethodFilter> for MethodFilter
impl PartialEq<MethodFilter> for MethodFilter
sourcefn eq(&self, other: &MethodFilter) -> bool
fn eq(&self, other: &MethodFilter) -> bool
sourceimpl PartialOrd<MethodFilter> for MethodFilter
impl PartialOrd<MethodFilter> for MethodFilter
sourcefn partial_cmp(&self, other: &MethodFilter) -> Option<Ordering>
fn partial_cmp(&self, other: &MethodFilter) -> Option<Ordering>
1.0.0 · sourceconst fn le(&self, other: &Rhs) -> bool
const fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<MethodFilter> for MethodFilter
impl Sub<MethodFilter> for MethodFilter
type Output = MethodFilter
type Output = MethodFilter
-
operator.sourceimpl SubAssign<MethodFilter> for MethodFilter
impl SubAssign<MethodFilter> for MethodFilter
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl TryFrom<Method> for MethodFilter
impl TryFrom<Method> for MethodFilter
sourceimpl UpperHex for MethodFilter
impl UpperHex for MethodFilter
impl Copy for MethodFilter
impl Eq for MethodFilter
impl StructuralEq for MethodFilter
impl StructuralPartialEq for MethodFilter
Auto Trait Implementations
impl RefUnwindSafe for MethodFilter
impl Send for MethodFilter
impl Sync for MethodFilter
impl Unpin for MethodFilter
impl UnwindSafe for MethodFilter
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.