Struct CTorClientKeystoreConfigBuilder

#[non_exhaustive]
pub struct CTorClientKeystoreConfigBuilder {
    id: Option<KeystoreId>,
    path: Option<PathBuf>,
}

Builder for CTorClientKeystoreConfig.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Option<KeystoreId>

The identifier of this keystore.

Each keystore must have a unique identifier. It is an error to configure multiple keystores with the same KeystoreId.

path: Option<PathBuf>

The root directory of this keystore.

This should be set to the ClientOnionAuthDir of your client. If Arti is configured to run as a client (i.e. if it runs in SOCKS proxy mode), it will read the client restricted discovery keys from this path.

The key files are expected to have the .auth_private extension, and their content must be of the form: <56-char-onion-addr-without-.onion-part>:descriptor:x25519:<x25519 private key in base32>.

Malformed files, and files that don’t have the .auth_private extension, will be ignored.

Implementations

impl CTorClientKeystoreConfigBuilder

pub fn id(&mut self, value: KeystoreId) -> &mut Self

The identifier of this keystore.

Each keystore must have a unique identifier. It is an error to configure multiple keystores with the same KeystoreId.

pub fn path(&mut self, value: PathBuf) -> &mut Self

The root directory of this keystore.

This should be set to the ClientOnionAuthDir of your client. If Arti is configured to run as a client (i.e. if it runs in SOCKS proxy mode), it will read the client restricted discovery keys from this path.

The key files are expected to have the .auth_private extension, and their content must be of the form: <56-char-onion-addr-without-.onion-part>:descriptor:x25519:<x25519 private key in base32>.

Malformed files, and files that don’t have the .auth_private extension, will be ignored.

pub fn build(&self) -> Result<CTorClientKeystoreConfig, ConfigBuildError>

Builds a new CTorClientKeystoreConfig.

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.

Trait Implementations

impl Clone for CTorClientKeystoreConfigBuilder

fn clone(&self) -> CTorClientKeystoreConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CTorClientKeystoreConfigBuilder

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

Formats the value using the given formatter.

impl Default for CTorClientKeystoreConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CTorClientKeystoreConfigBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CTorClientKeystoreConfigBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.