pub struct OnlineWithAuthentication { /* private fields */ }
Expand description

Run Ditto in secure production mode, logging on to Ditto Cloud or an on-premises authentication server. User permissions are centrally managed. Sync will not work until a successful login has occurred.

The only required configuration is the application’s UUID, which can be found on the Ditto portal where the app is registered.

By default cloud sync is enabled. This means the SDK will sync to a Big Peer in Ditto’s cloud when an internet connection is available. This is controlled by the enableDittoCloudSync parameter. If true (default), a suitable wss:// URL will be added to the TransportConfig.

To prevent cloud sync, or to specify your own URL later, pass false.

Authentication requests are handled by Ditto’s cloud by default, configured in the portal at <>.

To use a different or on-premises authentication service, pass a custom HTTPS base URL as the * auth_url parameter.


Construct an OnlineWithAuthentication Identity

  • ditto_root - The directory containing ditto local storage
  • app_id - The unique identifier of the application, usually a UUIDv4 string
  • auth_event_handler - A user created type which implements the DittoAuthenticationEventHandler trait
  • enable_cloud_sync - where cloud sync should be started by default
  • custom_auth_url - an optional custom authentication URL; default is is

Trait Implementations

Returns a shared reference to the underlying AuthClient
Returns if the current web auth token is valid
Returns if the configured x509 certificate is valid
Indicates if cloud sync should be enabled by default
Returns the configured URL for Auth
Returns the configured URL for websocket sync
Returns the underlying DittoAuthenticator if specified
Constructs a ValidityListener given a shared reference to the Ditto Transports Read more
Indicates whether the specific Identity type requires an offline only license token to be set. Read more
Returns the current SiteId identifying the Ditto peer
Returns the current AppId

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Converts to T by calling Into<T>::into.
Tries to convert to T by calling TryInto<T>::try_into.
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.