Enum DittoConfigConnect

#[non_exhaustive]
pub enum DittoConfigConnect {
    Server {
        url: Url,
    },
    SmallPeersOnly {
        private_key: Option<Vec<u8>>,
    },
}

Specifies the connection mechanism to be used by the Ditto instance.

Example

use dittolive_ditto::prelude::*;
let connect_config = DittoConfigConnect::Server {
    url: "https://example.com/your-server-url".parse().unwrap(),
};
let connect_config = DittoConfigConnect::SmallPeersOnly {
    private_key: Some("REPLACE_ME_WITH_YOUR_PRIVATE_KEY".bytes().collect()),
};
let connect_config = DittoConfigConnect::SmallPeersOnly { private_key: None };

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Server

Connect to a Ditto “Big Peer” using the provided URL.

When using Server mode, you must provide an authentication expiration handler using ditto.auth()?.set_expiration_handler(...).

Fields

url: Url

The “Auth URL” from the Ditto Portal, if using a Ditto-hosted Big Peer.

If using a self-hosted Big Peer, provide your custom authentication URL.

Example

// Where this subdomain is your Ditto `databaseId` (formerly `AppId`)
https://00000000-0000-0000-0000-000000000000.cloud.ditto.live

SmallPeersOnly

Connect only to other Ditto small peers, using the provided private key.

If no private key is provided, sync traffic will be UNENCRYPTED. This mode should NOT be used in production, only for development and testing purposes.

Fields

private_key: Option<Vec<u8>>

Trait Implementations

impl Clone for DittoConfigConnect

fn clone(&self) -> DittoConfigConnect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DittoConfigConnect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DittoConfigConnect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DittoConfigConnect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.