Struct KeyPathInfoBuilder

pub struct KeyPathInfoBuilder {
    summary: Option<String>,
    role: Option<String>,
    extra_info: Option<BTreeMap<String, String>>,
}

Builder for KeyPathInfo.

Fields

summary: Option<String>

A human-readable summary string describing what the KeyPath is for.

This should not recapitulate information in the extra_info.

role: Option<String>

The key role, ie its official name in the Tor Protocols.

This should usually start with KS_.

extra_info: Option<BTreeMap<String, String>>

Additional information, in the form of key-value pairs.

This will contain human-readable information that describes the individual components of a KeyPath. For example, for the ArtiPath hs/foo/KS_hs_id.expanded_ed25519_private, the extra information could be ("kind", "service), ("nickname", "foo"), etc.

Implementations

impl KeyPathInfoBuilder

pub fn summary(&mut self, value: String) -> &mut Self

A human-readable summary string describing what the KeyPath is for.

This should not recapitulate information in the extra_info.

pub fn role(&mut self, value: String) -> &mut Self

The key role, ie its official name in the Tor Protocols.

This should usually start with KS_.

pub fn build(&self) -> Result<KeyPathInfo, KeyPathInfoBuilderError>

Builds a new KeyPathInfo.

Errors

If a required field has not been initialized.

fn create_empty() -> Self

Create an empty builder, with all fields set to None or PhantomData.

impl KeyPathInfoBuilder

pub fn set_all_extra_info( &mut self, all_extra_info: impl Iterator<Item = (String, String)>, ) -> &mut Self

Initialize the additional information of this builder with the specified values.

Erases the preexisting extra_info.

pub fn extra_info( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Append the specified key-value pair to the extra_info.

The preexisting extra_info is preserved.

Trait Implementations

impl Clone for KeyPathInfoBuilder

fn clone(&self) -> KeyPathInfoBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for KeyPathInfoBuilder

fn default() -> Self

Returns the “default value” for a type.