Struct dittolive_ditto::ditto::AppId

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

The Ditto application Id

Implementations

impl AppId

pub fn generate() -> Self

Generate a random AppId from a UUIDv4

pub fn from_uuid(uuid: Uuid) -> Self

Generate an AppId from a given UUIDv4

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

Attempt to grab a specific AppId 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

Return the default auth URL associated with the app Id. This is of the form https://{app_id}.cloud.ditto.live/ by default.

pub fn default_sync_url(&self) -> String

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

Trait Implementations

impl Clone for AppId

fn clone(&self) -> AppId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppId

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

Formats the value using the given formatter.

impl Display for AppId

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

Formats the value using the given formatter.

impl FromStr for AppId

type Err = DittoError

The associated error which can be returned from parsing.

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

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