Struct CTorServiceKeystoreConfigBuilder

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

Builder for CTorServiceKeystoreConfig.

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 C Tor keystore must:

• have a unique identifier. It is an error to configure multiple keystores with the same KeystoreId.
• have a corresponding arti hidden service configured in the [onion_services] section with the same nickname

path: Option<PathBuf>

The root directory of this keystore.

This should be set to the HiddenServiceDirectory of your hidden service. Arti will read HiddenServiceDirectory/hostname and HiddenServiceDirectory/private_key. (Note: if your service is running in restricted discovery mode, you must also set the [[onion_services."<the nickname of your svc>".restricted_discovery.key_dirs]] to HiddenServiceDirectory/client_keys).

nickname: Option<HsNickname>

The nickname of the service this keystore is to be used with.

Implementations

impl CTorServiceKeystoreConfigBuilder

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

The identifier of this keystore.

Each C Tor keystore must:

• have a unique identifier. It is an error to configure multiple keystores with the same KeystoreId.
• have a corresponding arti hidden service configured in the [onion_services] section with the same nickname

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

The root directory of this keystore.

This should be set to the HiddenServiceDirectory of your hidden service. Arti will read HiddenServiceDirectory/hostname and HiddenServiceDirectory/private_key. (Note: if your service is running in restricted discovery mode, you must also set the [[onion_services."<the nickname of your svc>".restricted_discovery.key_dirs]] to HiddenServiceDirectory/client_keys).

pub fn nickname(&mut self, value: HsNickname) -> &mut Self

The nickname of the service this keystore is to be used with.

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

Builds a new CTorServiceKeystoreConfig.

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 CTorServiceKeystoreConfigBuilder

fn clone(&self) -> CTorServiceKeystoreConfigBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CTorServiceKeystoreConfigBuilder

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

Formats the value using the given formatter.

impl Default for CTorServiceKeystoreConfigBuilder

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CTorServiceKeystoreConfigBuilder

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CTorServiceKeystoreConfigBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.