Struct Nickname 

pub struct Nickname(/* private fields */);

A validated relay nickname.

Nicknames are human-readable identifiers for relays, consisting of 1 to 19 alphanumeric ASCII characters. This type ensures the nickname is valid at construction time.

Format

• Length: 1 to 19 characters
• Characters: ASCII alphanumeric only (a-z, A-Z, 0-9)

Example

use stem_rs::types::Nickname;
use std::str::FromStr;

let nick = Nickname::from_str("MyRelay").unwrap();
assert_eq!(nick.as_str(), "MyRelay");

let invalid = Nickname::from_str("my-relay");
assert!(invalid.is_err());

Implementations

impl Nickname

pub fn new(s: impl Into<String>) -> Result<Self, NicknameError>

Creates a new nickname from a string.

Errors

Returns an error if the string is not 1-19 alphanumeric characters.

pub fn as_str(&self) -> &str

Returns the nickname as a string slice.

Trait Implementations

impl Clone for Nickname

fn clone(&self) -> Nickname

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Nickname

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

Formats the value using the given formatter.

impl Display for Nickname

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

Formats the value using the given formatter.

impl FromStr for Nickname

type Err = NicknameError

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 Nickname

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 Nickname

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

impl StructuralPartialEq for Nickname