Struct V3OnionServiceId 

pub struct V3OnionServiceId { /* private fields */ }

A v3 onion-service id

Implementations

impl V3OnionServiceId

Strongly-typed representation of a v3 onion-service id

pub fn from_string(service_id: &str) -> Result<V3OnionServiceId, Error>

Create a V3OnionServiceId from a String in the version 3 onion service digest format. From the tor address specification:

onion_address = base32(PUBKEY | CHECKSUM | VERSION)
CHECKSUM = H(".onion checksum" | PUBKEY | VERSION)[:2]

where:
- PUBKEY is the 32 bytes ed25519 master pubkey of the onion service.
- VERSION is a one byte version field (default value '\x03')
- ".onion checksum" is a constant string
- H is SHA3-256
- CHECKSUM is truncated to two bytes before inserting it in onion_address

pub fn from_public_key(public_key: &Ed25519PublicKey) -> V3OnionServiceId

Create a V3OnionServiceId from an Ed25519PublicKey.

pub fn from_private_key(private_key: &Ed25519PrivateKey) -> V3OnionServiceId

Create a V3OnionServiceId from an Ed25519PrivateKey.

pub fn is_valid(service_id: &str) -> bool

Determine if the provided string is a valid representation of a V3OnionServiceId

pub fn as_bytes(&self) -> &[u8; 56]

View this service id as an array of bytes

Trait Implementations

impl Clone for V3OnionServiceId

fn clone(&self) -> V3OnionServiceId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for V3OnionServiceId

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

Formats the value using the given formatter.

impl Display for V3OnionServiceId

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

Formats the value using the given formatter.

impl Hash for V3OnionServiceId

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 Ord for V3OnionServiceId

fn cmp(&self, other: &V3OnionServiceId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for V3OnionServiceId

fn eq(&self, other: &V3OnionServiceId) -> 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 PartialOrd for V3OnionServiceId

fn partial_cmp(&self, other: &V3OnionServiceId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for V3OnionServiceId

impl StructuralPartialEq for V3OnionServiceId