Builder

Struct Builder 

Source
pub struct Builder { /* private fields */ }
Expand description

Augments a SIWE message with encoded capability delegations.

Implementations§

Source§

impl Builder

Source

pub fn new() -> Builder

Initialise a new Builder.

Source

pub fn default_actions(&self, namespace: &Namespace) -> Option<&Set<String>>

Inspect the default actions for a namespace.

Source

pub fn actions( &self, namespace: &Namespace, ) -> Option<&BTreeMap<String, Set<String>>>

Inspect the targeted actions for a namespace.

Source

pub fn extra_fields( &self, namespace: &Namespace, ) -> Option<&HashMap<String, Value>>

Inspect the extra fields for a namespace.

Source

pub fn with_default_action<S>(self, namespace: &Namespace, action: S) -> Self
where S: Into<String>,

Extend the set of default actions for a namespace.

Source

pub fn with_default_actions<I, S>( self, namespace: &Namespace, actions: I, ) -> Self
where S: Into<String>, I: IntoIterator<Item = S>,

Extend the set of default actions for a namespace.

Source

pub fn with_action<T, S>( self, namespace: &Namespace, target: T, action: S, ) -> Self
where T: Into<String>, S: Into<String>,

Extend the set of actions for a target in a namespace.

Source

pub fn with_actions<I, S, T>( self, namespace: &Namespace, target: T, actions: I, ) -> Self
where T: Into<String>, S: Into<String>, I: IntoIterator<Item = S>,

Extend the set of actions for a target in a namespace.

Source

pub fn with_extra_fields( self, namespace: &Namespace, fields: HashMap<String, Value>, ) -> Self

Extend the extra fields for a namespace.

This function performs a simple HashMap::extend, so does not merge serde_json::Values. Any existing fields with a key matching the incoming fields will be overwritten.

Source

pub fn build(&self, message: Message) -> Result<Message, Error>

Augment the SIWE message with encoded capabilities.

Source

pub fn statement(&self, uri: &UriString) -> Option<String>

Generate a CapGrok statement from capabilities and URI.

Trait Implementations§

Source§

impl Debug for Builder

Source§

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

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

impl Default for Builder

Source§

fn default() -> Builder

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

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V