Struct LibdcafEncodedScope 

pub struct LibdcafEncodedScope(/* private fields */);

A scope encoded using the Authorization Information Format (AIF) for ACE as in AifEncodedScope, but only consisting of a single AifEncodedScopeElement instead of an array of them.

This is done to provide interoperability support for the libdcaf implementation, which currently uses this format to describe its scopes.

This struct is only provided to allow compatability with the libdcaf implementation—if you don’t require this, simply use the spec-compliant AifEncodedScope instead, as it provides a superset of the functionality of this type.

Refer to AifEncodedScope for details on the format, and “Difference to AifEncodedScope” for details on the difference to it.

Example

To create a scope allowing only the GET and FETCH methods to be called the local URI readonly:

let scope = LibdcafEncodedScope::new("readonly", AifRestMethod::Get | AifRestMethod::Fetch);
assert_eq!(scope.element().permissions.bits(), u64::pow(2, 0) + u64::pow(2, 4));

Difference to AifEncodedScope

The only difference here is that while AifEncodedScope would encode the above example like so (given as JSON):

[["readonly", 17]]

LibdcafEncodedScope would encode it like so:

["readonly", 17]

Note that this implies that the latter only allows a single scope element (i.e. a single row in the access matrix) to be specified, while the former allows multiple elements. As mentioned in the beginning, only use this struct if you need to communicate with libdcaf, use AifEncodedScope in all other cases.

Implementations

impl LibdcafEncodedScope

pub fn new<T>( path: T, permissions: BitFlags<AifRestMethod>, ) -> LibdcafEncodedScope

where T: Into<String>,

Creates a new libdcaf-encoded scope from the given path and permissions.

Refer to AifEncodedScopeElement::new for details and an example applicable to this method.

pub fn from_element(element: AifEncodedScopeElement) -> LibdcafEncodedScope

Creates a new libdcaf-encoded scope from the given element.

Refer to AifEncodedScopeElement and LibdcafEncodedScope for details.

pub fn try_from_bits<T>( path: T, permissions: u64, ) -> Result<LibdcafEncodedScope, InvalidAifEncodedScopeError>

where T: Into<String>,

Tries to create a new libdcaf-encoded scope from the given path and permissions.

The given permissions must be a valid bitmask of the allowed REST methods, as defined in section 3 of RFC 9237.

Errors

Refer to AifEncodedScopeElement::try_from_bits.

Example

Refer to AifEncodedScopeElement::try_from_bits.

pub fn element(&self) -> &AifEncodedScopeElement

Returns a reference to the single element contained in this scope.

pub fn to_element(self) -> AifEncodedScopeElement

Returns the single element contained in this scope.

pub fn elements(&self) -> Vec<&AifEncodedScopeElement>

Returns a vector of a reference to the single element in this scope.

pub fn to_elements(self) -> Vec<AifEncodedScopeElement>

Returns a vector of the single element in this scope.

Trait Implementations

impl Clone for LibdcafEncodedScope

fn clone(&self) -> LibdcafEncodedScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LibdcafEncodedScope

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

Formats the value using the given formatter.

impl From<LibdcafEncodedScope> for Scope

fn from(value: LibdcafEncodedScope) -> Self

Converts to this type from the input type.

impl Hash for LibdcafEncodedScope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LibdcafEncodedScope

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LibdcafEncodedScope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Scope> for LibdcafEncodedScope

type Error = WrongSourceTypeError<Scope>

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for LibdcafEncodedScope

impl StructuralPartialEq for LibdcafEncodedScope