Struct HsClientSecretKeys

pub struct HsClientSecretKeys { /* private fields */ }

Service discovery keys (if any) to use when connecting to a specific onion service.

Represents a possibly empty subset of the following keys:

• KS_hsc_desc_enc, HsClientDescEncKeypair
• KS_hsc_intro_auth, HsClientIntroAuthKeypair

HsClientSecretKeys is constructed with a Builder: use ClientSecretKeysBuilder::default(), optionally call setters, and then call build().

For client connections to share circuits and streams, call build only once. Different calls to build yield HsClientSecretKeys values which won’t share HS circuits, streams, or authentication.

Conversely, Clones of an HsClientSecretKeys can share circuits. All empty HsClientSecretKeys (for example, from :none()) can share circuits.

Implementations

impl HsClientSecretKeys

pub fn none() -> Self

Create a new HsClientSecretKeys, for making connections to services that are not running in restricted discovery mode.

Creates a HsClientSecretKeys which has no actual keys, so will not use a descriptor cookie when decrypting the second layer of descriptor encryption.

pub fn is_empty(&self) -> bool

Tests whether this HsClientSecretKeys actually contains any keys

Trait Implementations

impl Clone for HsClientSecretKeys

fn clone(&self) -> HsClientSecretKeys

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HsClientSecretKeys

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

Formats the value using the given formatter.

impl Default for HsClientSecretKeys

fn default() -> HsClientSecretKeys

Returns the “default value” for a type.

impl Hash for HsClientSecretKeys

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HsClientSecretKeys

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for HsClientSecretKeys