Struct HsNickname

pub struct HsNickname(Slug);

Nickname (local identifier) for a Tor hidden service

Used to look up this services’s keys, state, configuration, etc, and distinguish them from other services.

An HsNickname must be a valid Slug. See slug for the syntactic requirements.

Tuple Fields

0: Slug

Implementations

impl HsNickname

pub fn new(s: String) -> Result<HsNickname, InvalidNickname>

Create a new HsNickname from a String

Returns an error if the syntax is not valid

Trait Implementations

impl AsRef<str> for HsNickname

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for HsNickname

fn clone(&self) -> HsNickname

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HsNickname

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HsNickname

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HsNickname

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

Formats the value using the given formatter.

impl From<HsNickname> for Slug

fn from(value: HsNickname) -> Self

Converts to this type from the input type.

impl From<HsNickname> for String

fn from(nick: HsNickname) -> String

Converts to this type from the input type.

impl From<Slug> for HsNickname

fn from(value: Slug) -> Self

Converts to this type from the input type.

impl FromStr for HsNickname

type Err = InvalidNickname

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for HsNickname

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 InstanceIdentity for HsNickname

Available on crate feature state-dir only.

fn kind() -> &'static str

Return the kind. For example hss for a Tor Hidden Service.

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

Obtain identity

impl Ord for HsNickname

fn cmp(&self, other: &HsNickname) -> 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 HsNickname

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

fn partial_cmp(&self, other: &HsNickname) -> 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 Serialize for HsNickname

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for HsNickname

type Error = InvalidNickname

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<HsNickname, InvalidNickname>

Performs the conversion.

impl Eq for HsNickname

impl StructuralPartialEq for HsNickname