Struct UserData

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

Under the hood this is a UTF-8 String is no longer than UserData::MAX_LENGTH bytes.

Iroh does not keep track of or examine the user-defined data.

UserData implements FromStr and TryFrom<String>, so you can convert &str and String into UserData easily.

Implementations

impl UserData

pub const MAX_LENGTH: usize = 245usize

The max byte length allowed for user-defined data.

In DNS discovery services, the user-defined data is stored in a TXT record character string, which has a max length of 255 bytes. We need to subtract the user-data= prefix, which leaves 245 bytes for the actual user-defined data.

Trait Implementations

impl AsRef<str> for UserData

fn as_ref(&self) -> &str

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

impl Clone for UserData

fn clone(&self) -> UserData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserData

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

Formats the value using the given formatter.

impl Display for UserData

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

Formats the value using the given formatter.

impl FromStr for UserData

type Err = MaxLengthExceededError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UserData, <UserData as FromStr>::Err>

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

impl Hash for UserData

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

where __H: Hasher,

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 UserData

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

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

fn partial_cmp(&self, other: &UserData) -> 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 TryFrom<String> for UserData

type Error = MaxLengthExceededError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<UserData, <UserData as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for UserData

impl StructuralPartialEq for UserData