Struct Connection

#[non_exhaustive]
pub struct Connection {
    pub id: String,
    pub peer_key_string1: String,
    pub peer_key_string2: String,
    pub connection_type: ConnectionType,
    pub approximate_distance_in_meters: Option<f32>,
    /* private fields */
}

Represents a connection between two peers in a Ditto mesh network.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: String

An string ID in the form "from<->to:connection_type". These ids are stable: the lower site Id will always be placed first.

Example

“1<->2:Bluetooth”

peer_key_string1: String

The peer key of the peer at one end of the connection, as a String

The assignment to peer_key_string1 and peer_key_string2 is deterministic and stable for any two peers.

peer_key_string2: String

The peer key of the peer at the other end of the connection, as a String

The assignment to peer_key_string1 and peer_key_string2 is deterministic and stable for any two peers.

connection_type: ConnectionType

The type of connection. One Connection will exist for each connection type that might be active.

approximate_distance_in_meters: Option<f32>

A made-up figure that changes based on RSSI. This may become meaningful if more accurate range-finding transports are added in future.

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Connection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for Connection

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

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

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

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 Connection