Struct DatabaseId 

pub struct DatabaseId(/* private fields */);

The ID of this Ditto database, used to determine which peers to sync with

Implementations

impl DatabaseId

pub fn generate() -> Self

Generate a random DatabaseId from a UUIDv4

pub fn from_uuid(uuid: Uuid) -> Self

Generate a DatabaseId from a given UUIDv4

pub fn from_env(var: &str) -> Result<Self, DittoError>

Attempt to grab a specific DatabaseId from some environment variable

pub fn as_str(&self) -> &str

Return the corresponding string

pub fn to_c_string(&self) -> Box

Return the corresponding c string

pub fn default_auth_url(&self) -> String

👎Deprecated: Use the URL from Ditto Portal

This method is deprecated and will be removed in v6. The URL can be found in the Ditto Portal. We recommend storing the URL alongside other configuration like the database ID.

Return the default auth URL associated with the database ID. This is of the form https://{database_id}.cloud.ditto.live/ by default.

pub fn default_sync_url(&self) -> String

👎Deprecated: No longer needed for configuration in Ditto v5

This method is deprecated and will be removed in v6. The WebSocket sync URL was needed in v4, but is no longer needed in v5.

Return the default WebSocket sync URL which is of the form wss://{database_id}.cloud.ditto.live/ by default.

Trait Implementations

impl Clone for DatabaseId

fn clone(&self) -> DatabaseId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DatabaseId

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

Formats the value using the given formatter.

impl Display for DatabaseId

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

Formats the value using the given formatter.

impl FromStr for DatabaseId

type Err = DittoError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<DatabaseId, DittoError>

Parses a string s to return a value of this type.