Skip to main content

ScopeSet

Struct ScopeSet 

Source
pub struct ScopeSet(/* private fields */);
Expand description

A bounded set of unique scopes with deterministic canonical ordering.

The JSON wire form is an array sorted by exact ASCII byte order. Duplicate input is rejected rather than silently deduplicated. These properties make authorization decisions, audit records, and canonical hashes reproducible.

Implementations§

Source§

impl ScopeSet

Source

pub const MAX_LEN: usize = 128

Maximum number of distinct scopes in one set.

Source

pub const fn empty() -> Self

Returns an empty scope set.

Source

pub fn try_new<I>(scopes: I) -> Result<Self, ScopeSetError>
where I: IntoIterator<Item = Scope>,

Constructs a set from already validated scopes.

§Errors

Returns ScopeSetError on the first duplicate or when more than ScopeSet::MAX_LEN distinct entries are observed. Iteration stops at that point, so an unbounded iterator cannot cause unbounded work.

Source

pub fn len(&self) -> usize

Returns the number of scopes.

Source

pub fn is_empty(&self) -> bool

Returns true when no authority is represented.

Source

pub fn contains(&self, scope: &Scope) -> bool

Returns true when the exact, case-sensitive scope is present.

Source

pub fn iter(&self) -> Iter<'_, Scope> ⓘ

Returns scopes in deterministic ASCII byte order.

Source

pub fn is_subset(&self, other: &Self) -> bool

Returns true when every scope in this set is present in other.

Source

pub fn intersection(&self, other: &Self) -> Self

Returns the scopes granted by both sets.

Intersection can only narrow authority and cannot exceed either input’s validated size bound.

Trait Implementations§

Source§

impl Clone for ScopeSet

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ScopeSet

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ScopeSet

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for ScopeSet

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ScopeSet

Source§

impl<'a> IntoIterator for &'a ScopeSet

Source§

type Item = &'a Scope

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, Scope>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl JsonSchema for ScopeSet

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for ScopeSet

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ScopeSet

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ScopeSet

Source§

impl TryFrom<Vec<Scope>> for ScopeSet

Source§

type Error = ScopeSetError

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

fn try_from(scopes: Vec<Scope>) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn try_from(value: U) -> Result<T, !>

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.