Struct TransportConfig

pub struct TransportConfig {
    pub peer_to_peer: PeerToPeer,
    pub connect: Connect,
    pub listen: Listen,
    pub global: Global,
}

A configuration object specifying which network transports Ditto should use to sync data.

A Ditto object comes with a default transport configuration where all available peer-to-peer transports are enabled. You can customize this by initializing a TransportConfig, adjusting its properties, and supplying it to set_transport_config() on Ditto.

When you initialize a TransportConfig yourself it starts with all transports disabled. You must enable each one directly.

Peer-to-peer transports will automatically discover peers in the vicinity and create connections without any configuration. These are configured inside the peer_to_peer property. To turn each one on, set its enabled property to true.

To connect to a peer at a known location, such as a Ditto Big Peer, add its address inside the connect configuration. These are either host:port strings for raw TCP sync, or a wss://… URL for websockets.

The listen configurations are for specific less common data sync scenarios. Please read the documentation on the Ditto website for examples. Incorrect use of listen can result in insecure configurations.

Fields

peer_to_peer: PeerToPeer

Configure Bluetooth and LAN transports.

connect: Connect

Configure TCP and WebSocket outbound transports.

listen: Listen

Configure TCP and HTTP inbound transports.

global: Global

Set peer-global transport settings.

Implementations

impl TransportConfig

pub fn new() -> Self

Create a new TransportConfig with default settings.

pub fn enable_all_peer_to_peer(&mut self)

Enables peer-to-peer transports in this config.

Trait Implementations

impl Clone for TransportConfig

fn clone(&self) -> TransportConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransportConfig

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

Formats the value using the given formatter.

impl Default for TransportConfig

fn default() -> TransportConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransportConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TransportConfig

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

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 TransportConfig

impl StructuralPartialEq for TransportConfig