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>,
}
Expand description

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

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Deserialize this value from the given Serde deserializer. Read more
This method returns an Ordering between self and other. Read more
Compares and returns the maximum of two values. Read more
Compares and returns the minimum of two values. Read more
Restrict a value to a certain interval. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
This method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Applies the [Compat] adapter by value. Read more
Applies the [Compat] adapter by shared reference. Read more
Applies the [Compat] adapter by mutable reference. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Converts to T by calling Into<T>::into.
Tries to convert to T by calling TryInto<T>::try_into.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.