Struct dittolive_ditto::transport::Peer

pub struct Peer {
    pub address: DittoAddress,
    pub peer_key: Vec<u8>,
    pub device_name: String,
    pub os: Option<PresenceOs>,
    pub query_overlap_group: u8,
    pub is_connected_to_ditto_cloud: bool,
    pub is_compatible: Option<bool>,
    pub ditto_sdk_version: Option<String>,
    pub connections: Vec<UndirectedConnection>,
}

Peer in the Ditto mesh.

Fields

address: DittoAddress

An address uniquely representing another device on the Ditto network.

peer_key: Vec<u8>

The peer key is a unique identifier for a given peer, equal to or derived from the cryptographic public key used to authenticate it.

NOTE: This will be be empty when a peer is not updated to the latest version of the SDK.

device_name: String

The human-readable device name for a peer. This defaults to the the hostname but can be manually set by the application developer.

os: Option<PresenceOs>

The operating system of a peer (if known).

query_overlap_group: u8

An optional query overlap group which an app developer might provide to influence connection priorities. Values can range between 0-63 (inclusive). Defaults to 0 if not set.

is_connected_to_ditto_cloud: bool

Flag which indicates if this peer is connected to HyDRA. This is represented as a simple flag since attempting add HyDRA as a node to a graph would be extremely convoluted. The presence viewer depicts the HyDRA connection with a simple cloud icon above a peer.

is_compatible: Option<bool>

A simplified boolean flag indicating whether the is peer is compatible with our own peer (if known). Note that there might be connections to this peer even if incompatible with our own peer, provided that some other peers are able to interoperate.

ditto_sdk_version: Option<String>

The marketing version of the SDK (if known). For instance: "1.0.3".

connections: Vec<UndirectedConnection>

List of current connections between this peer and other peers.

Trait Implementations

impl Clone for Peer

fn clone(&self) -> Peer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Peer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Peer

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

Deserialize this value from the given Serde deserializer.

impl Ord for Peer

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Peer> for Peer

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Peer> for Peer

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

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 Peer

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 Peer