Struct DittoConfig 

#[non_exhaustive]
pub struct DittoConfig {
    pub database_id: String,
    pub connect: DittoConfigConnect,
    pub persistence_directory: Option<PathBuf>,
    pub system_parameters: HashMap<String, Value>,
    /* private fields */
}

Configuration options required to initialize a Ditto instance.

Example

const YOUR_DATABASE_ID: &str = "REPLACE ME WITH YOUR APP/DATABASE ID";
const YOUR_AUTH_URL: &str = "https://your-app.cloud.ditto.live";
const YOUR_PRIVATE_KEY: &str = "REPLACE ME WITH YOUR PRIVATE KEY";

let connect = DittoConfigConnect::Server {
    url: YOUR_AUTH_URL.parse().unwrap(),
};
let connect = DittoConfigConnect::SmallPeersOnly {
    private_key: Some(YOUR_PRIVATE_KEY.as_bytes().to_vec()),
};
let connect = DittoConfigConnect::SmallPeersOnly { private_key: None };
let config = DittoConfig::new(YOUR_DATABASE_ID, connect);

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.

database_id: String

An ID used to distinguish between Ditto database instantiations.

Note: This was formerly known as appId.

connect: DittoConfigConnect

The connection configuration this device uses to connect to a Ditto mesh.

persistence_directory: Option<PathBuf>

The directory where Ditto will store its data.

system_parameters: HashMap<String, Value>

System parameter overrides applied before Ditto initializes its subsystems.

Each key is a system parameter name. Names are case-insensitive. Each value must match the parameter’s Core-defined type and validation rules. The supported serde_json::Value shapes are:

• booleans and strings;
• nonnegative integers through u64::MAX, negative integers through i64::MIN, and finite floating-point numbers; and
• arrays and string-keyed objects containing those values recursively.

Nonnegative integers are normalized to Core’s unsigned integer representation, regardless of whether they were constructed from a signed or unsigned Rust integer. JSON null is not a system parameter type and is rejected, including inside arrays and objects. Binary values and CBOR tags cannot be represented by serde_json::Value.

Unsupported SDK value shapes, such as JSON null, return ErrorKind::InvalidInput. Unknown parameter names, values of the wrong type, and values outside a parameter’s valid range cause Ditto::open and Ditto::open_sync to return CoreApiErrorKind::ValidationInvalidDittoConfig.

Implementations

impl DittoConfig

pub fn new<S: Into<String>>(database_id: S, connect: DittoConfigConnect) -> Self

Create a new DittoConfig instance from a database ID and connection configuration.

pub fn with_persistence_directory<P: Into<PathBuf>>(self, path: P) -> Self

Optionally specify a custom persistence directory.

Trait Implementations

impl Clone for DittoConfig

fn clone(&self) -> DittoConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DittoConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DittoConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DittoConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.