Struct capgrok::Builder

pub struct Builder { /* private fields */ }

Augments a SIWE message with encoded capability delegations.

Implementations

impl Builder

pub fn new() -> Builder

Initialise a new Builder.

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

Inspect the default actions for a namespace.

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

Inspect the targeted actions for a namespace.

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

Inspect the extra fields for a namespace.

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.

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.

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.

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.

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.

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

Augment the SIWE message with encoded capabilities.

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

Generate a CapGrok statement from capabilities and URI.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.