Struct CustomAddr 

pub struct CustomAddr { /* private fields */ }

Available on crate feature key only.

A custom transport address consisting of a transport id and opaque address data.

This is a generic address type that allows external crates to implement custom transports for iroh.

Transport ids are freely chosen u64 numbers. A registry for well-known transport ids is maintained at https://github.com/n0-computer/iroh/blob/main/TRANSPORTS.md. The opaque address data is not validated or size-limited in any way.

String encoding

Used by Display and FromStr implementations. Format: <id>_<data> where <id> is the transport id as lowercase hex (no 0x prefix, no leading zeros) and <data> is the address bytes as lowercase hex, separated by _.

Binary encoding

Used by Self::to_vec and Self::from_bytes. Format: 8-byte little-endian u64 transport id, followed by raw address data bytes. The minimum valid length is 8 bytes (id only with empty data).

Implementations

impl CustomAddr

pub fn from_parts(id: u64, data: &[u8]) -> Self

Creates a new CustomAddr from a transport id and raw address data.

pub fn id(&self) -> u64

Returns the transport id.

You can freely choose this. There is a table of reserved custom transport ids in https://github.com/n0-computer/iroh/blob/main/TRANSPORTS.md, where you could submit your transport for registration to get a reserved id.

But this is only relevant if you care for interop.

pub fn data(&self) -> &[u8]

Returns the opaque address data for this transport.

Below a certain size (currently 30 bytes) this is stored inline, otherwise on the heap.

Note that there are no guarantees about the size of this data. When parsing custom addresses you must be prepared to handle unexpected sizes here.

pub fn to_vec(&self) -> Vec<u8>

Serializes to the binary encoding.

See CustomAddr docs for details on the encoding.

pub fn from_bytes(data: &[u8]) -> Result<Self, &'static str>

Parses from the binary encoding.

See CustomAddr docs for details on the encoding.

Trait Implementations

impl Clone for CustomAddr

fn clone(&self) -> CustomAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CustomAddr

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

Formats the value using the given formatter.

impl Eq for CustomAddr

impl From<(u64, &[u8])> for CustomAddr

fn from((id, data): (u64, &[u8])) -> Self

Converts to this type from the input type.

impl FromStr for CustomAddr

type Err = CustomAddrParseError

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 CustomAddr

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 CustomAddr

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CustomAddr