Enum ChannelAddr

pub enum ChannelAddr {
    Tcp(SocketAddr),
    MetaTls(Hostname, Port),
    Local(u64),
    Sim(SimAddr),
    Unix(SocketAddr),
}

The type of a channel address, used to multiplex different underlying channel implementations. ChannelAddrs also have a concrete syntax: the address type (e.g., “tcp” or “local”), followed by “:”, and an address parseable to that type. For example:

• tcp:127.0.0.1:1234 - localhost port 1234 over TCP
• tcp:192.168.0.1:1111 - 192.168.0.1 port 1111 over TCP
• local:123 - the (in-process) local port 123
• unix:/some/path - the Unix socket at /some/path

Both local and TCP ports 0 are reserved to indicate “any available port” when serving.

let addr: ChannelAddr = "tcp:127.0.0.1:1234".parse().unwrap();
let ChannelAddr::Tcp(socket_addr) = addr else {
    panic!()
};
assert_eq!(socket_addr.port(), 1234);
assert_eq!(socket_addr.is_ipv4(), true);

Variants

Tcp(SocketAddr)

A socket address used to establish TCP channels. Supports both IPv4 and IPv6 address / port pairs.

MetaTls(Hostname, Port)

An address to establish TCP channels with TLS support within Meta. Composed of hostname and port.

Local(u64)

Local addresses are registered in-process and given an integral index.

Sim(SimAddr)

Sim is a simulated channel for testing.

Unix(SocketAddr)

A unix domain socket address. Supports both absolute path names as well as “abstract” names per https://manpages.debian.org/unstable/manpages/unix.7.en.html#Abstract_sockets

Implementations

impl ChannelAddr

pub fn any(transport: ChannelTransport) -> Self

The “any” address for the given transport type. This is used to servers to “any” address.

pub fn transport(&self) -> ChannelTransport

The transport used by this address.

Trait Implementations

impl Clone for ChannelAddr

fn clone(&self) -> ChannelAddr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelAddr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelAddr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Dispatcher<ChannelAddr> for SimDispatcher

fn send<'life0, 'async_trait>( &'life0 self, addr: ChannelAddr, data: Serialized, ) -> Pin<Box<dyn Future<Output = Result<(), SimNetError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Send a raw data blob to the given target.

impl Display for ChannelAddr

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

Formats the value using the given formatter.

impl From<SocketAddr> for ChannelAddr

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for ChannelAddr

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl From<SocketAddr> for ChannelAddr

fn from(value: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for ChannelAddr

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for ChannelAddr

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 Named for ChannelAddr

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl Ord for ChannelAddr

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

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

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

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 ChannelAddr

impl StructuralPartialEq for ChannelAddr