Enum TransportTuple

pub enum TransportTuple {
    WithRemote {
        local_address: String,
        local_port: u16,
        remote_ip: IpAddr,
        remote_port: u16,
        protocol: Protocol,
    },
    LocalOnly {
        local_address: String,
        local_port: u16,
        protocol: Protocol,
    },
}

Tuple of local IP/port/protocol + optional remote IP/port.

Notes on usage

Both remote_ip and remote_port are unset until the media address of the remote endpoint is known, which happens after calling transport.connect() in PlainTransport and PipeTransport, or via dynamic detection as it happens in WebRtcTransport (in which the remote media address is detected by ICE means), or in PlainTransport (when using comedia mode).

Variants

WithRemote

Transport tuple with remote endpoint info.

Fields

local_address: String

Local IP address or hostname.

local_port: u16

Local port.

remote_ip: IpAddr

Remote IP address.

remote_port: u16

Remote port.

protocol: Protocol

Protocol

LocalOnly

Transport tuple without remote endpoint info.

Fields

local_address: String

Local IP address or hostname.

local_port: u16

Local port.

protocol: Protocol

Protocol

Implementations

impl TransportTuple

pub fn local_address(&self) -> &String

Local IP address or hostname.

pub fn local_port(&self) -> u16

Local port.

pub fn protocol(&self) -> Protocol

Protocol.

pub fn remote_ip(&self) -> Option<IpAddr>

Remote IP address.

pub fn remote_port(&self) -> Option<u16>

Remote port.

Trait Implementations

impl Clone for TransportTuple

fn clone(&self) -> TransportTuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransportTuple

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransportTuple

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TransportTuple

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 TransportTuple

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

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

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

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 TransportTuple

impl StructuralPartialEq for TransportTuple