Struct Capability 

pub struct Capability<NB> { /* private fields */ }

Representation of a set of delegated Capabilities.

Implementations

impl<NB> Capability<NB>

pub fn new() -> Self

Create a new empty Capability.

pub fn can<T, A>( &self, target: T, action: A, ) -> ConvertResult<Option<&NotaBeneCollection<NB>>, UriString, Ability, T, A>

where T: TryInto<UriString>, A: TryInto<Ability>,

Check if a particular action is allowed for the specified target, or is allowed globally.

pub fn can_do( &self, target: &UriString, action: &Ability, ) -> Option<&NotaBeneCollection<NB>>

Check if a particular action is allowed for the specified target, or is allowed globally, without type conversion.

pub fn merge<NB1, NB2>(self, other: Capability<NB1>) -> Capability<NB2>

where NB2: From<NB> + From<NB1>,

Merge this Capabilities set with another

pub fn with_action( &mut self, target: UriString, action: Ability, nb: impl IntoIterator<Item = BTreeMap<String, NB>>, ) -> &mut Self

Add an allowed action for the given target, with a set of note-benes

pub fn with_action_convert<T, A>( &mut self, target: T, action: A, nb: impl IntoIterator<Item = BTreeMap<String, NB>>, ) -> Result<&mut Self, ConvertError<T::Error, A::Error>>

where T: TryInto<UriString>, A: TryInto<Ability>,

Add an allowed action for the given target, with a set of note-benes.

This method automatically converts the provided args into the correct types for convenience.

pub fn with_actions( &mut self, target: UriString, abilities: impl IntoIterator<Item = (Ability, impl IntoIterator<Item = BTreeMap<String, NB>>)>, ) -> &mut Self

Add a set of allowed action for the given target, with associated note-benes

pub fn with_actions_convert<T, A, N>( &mut self, target: T, abilities: impl IntoIterator<Item = (A, N)>, ) -> Result<&mut Self, ConvertError<T::Error, A::Error>>

where T: TryInto<UriString>, A: TryInto<Ability>, N: IntoIterator<Item = BTreeMap<String, NB>>,

Add a set of allowed action for the given target, with associated note-benes.

This method automatically converts the provided args into the correct types for convenience.

pub fn abilities(&self) -> &CapsInner<NB>

Read the set of abilities granted in this capabilities set

pub fn abilities_for<T>( &self, target: T, ) -> Result<Option<&BTreeMap<Ability, NotaBeneCollection<NB>>>, T::Error>

where T: TryInto<UriString>,

Read the set of abilities granted for a given target in this capabilities set

pub fn proof(&self) -> &[Cid]

Read the set of proofs which support the granted capabilities

pub fn with_proof(self, proof: &Cid) -> Self

Add a supporting proof CID

pub fn with_proofs<'l>(self, proofs: impl IntoIterator<Item = &'l Cid>) -> Self

Add a set of supporting proofs

pub fn into_inner(self) -> (Capabilities<NB>, Vec<Cid>)

pub fn to_statement(&self) -> String

Generate a ReCap statement from capabilities and URI (delegee).

impl<NB> Capability<NB>

where NB: Serialize,

pub fn build_message(&self, message: Message) -> Result<Message, EncodingError>

Apply this capabilities set to a SIWE message by writing to it’s statement and resource list

impl<NB> Capability<NB>

where NB: for<'a> Deserialize<'a>,

pub fn extract_and_verify( message: &Message, ) -> Result<Option<Self>, VerificationError>

Extract the encoded capabilities from a SIWE message and ensures the correctness of the statement.

Trait Implementations

impl<NB: Clone> Clone for Capability<NB>

fn clone(&self) -> Capability<NB>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<NB: Debug> Debug for Capability<NB>

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

Formats the value using the given formatter.

impl<NB> Default for Capability<NB>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, NB> Deserialize<'de> for Capability<NB>

where NB: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<NB> Serialize for Capability<NB>

where NB: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<NB> TryFrom<&Capability<NB>> for UriString

where NB: Serialize,

type Error = EncodingError

The type returned in the event of a conversion error.

fn try_from(cap: &Capability<NB>) -> Result<Self, Self::Error>

Performs the conversion.

impl<NB> TryFrom<&RiString<UriSpec>> for Capability<NB>

where NB: for<'a> Deserialize<'a>,

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from(uri: &UriString) -> Result<Self, Self::Error>

Performs the conversion.