Struct ockam_core::Address

pub struct Address {
    pub tt: u8,
    // some fields omitted
}

A generic component address

The address type is parsed by routers to determine the next local hop in the router chain to resolve a route to a remote connection.

Parsing addresses

While addresses are concrete types, creating them from strings is possible for ergonomics reasons. When parsing an address from a string, the first # symbol is used to separate the type from the rest of the address. If no # symbol is found, the address is assumed to be of tt = 0 (local worker).

Fields

tt: u8

The address type

Implementations

impl Address

pub fn new<S: Into<String>>(tt: u8, inner: S) -> Self

Create a new address from separate type and data parts

pub fn from_string<S: Into<String>>(s: S) -> Self

Parse an address from a string

See type documentation for more detail

pub fn random(tt: u8) -> Self

Generate a random address with a specific type

Methods from Deref<Target = Vec<u8>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn as_ptr(&self) -> *const T

Returns a raw pointer to the vector’s buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

pub fn allocator(&self) -> &A

🔬 This is a nightly-only experimental API. (allocator_api)

Returns a reference to the underlying allocator.

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its ‘length’.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Deref for Address

type Target = Vec<u8>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Address

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Address

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

Formats the value using the given formatter.

impl Distribution<Address> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Address

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
    R: Rng, 

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
    F: Fn(T) -> S, 

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<'a> From<&'a [&'_ u8]> for Address

fn from(inner: &'a [&u8]) -> Self

Performs the conversion.

impl<'a> From<&'a [u8]> for Address

fn from(inner: &'a [u8]) -> Self

Performs the conversion.

impl<'a> From<&'a Address> for AddressSet

fn from(a: &'a Address) -> Self

Performs the conversion.

impl<'a> From<&'a str> for Address

fn from(s: &'a str) -> Self

Performs the conversion.

impl<'a> From<(u8, &'a str)> for Address

fn from((tt, inner): (u8, &'a str)) -> Self

Performs the conversion.

impl From<(u8, Vec<u8, Global>)> for Address

fn from((tt, inner): (u8, Vec<u8>)) -> Self

Performs the conversion.

impl From<Address> for AddressSet

fn from(a: Address) -> Self

Performs the conversion.

impl From<Address> for String

fn from(addr: Address) -> Self

Performs the conversion.

impl From<Address> for Route

fn from(address: Address) -> Self

Performs the conversion.

impl From<String> for Address

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for Address

fn from(inner: Vec<u8>) -> Self

Performs the conversion.

impl Hash for Address

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Address

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Address> for Address

fn eq(&self, other: &Address) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Address) -> bool

This method tests for !=.

impl PartialOrd<Address> for Address

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Address

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

Serialize this value into the given Serde serializer.

impl Eq for Address

impl StructuralEq for Address

impl StructuralPartialEq for Address