Struct RemoteSettingsService

pub struct RemoteSettingsService { /* private fields */ }

Application-level Remote Settings manager.

This handles application-level operations, like syncing all the collections, and acts as a factory for creating clients.

Implementations

impl RemoteSettingsService

pub fn new(storage_dir: String, config: RemoteSettingsConfig2) -> Self

Construct a RemoteSettingsService

This is typically done early in the application-startup process.

This method performs no IO or network requests and is safe to run in a main thread that can’t be blocked.

storage_dir is a directory to store SQLite files in – one per collection. If the directory does not exist, it will be created when the storage is first used. Only the directory and the SQLite files will be created, any parent directories must already exist.

pub fn make_client(&self, collection_name: String) -> Arc<RemoteSettingsClient>

Create a new Remote Settings client

This method performs no IO or network requests and is safe to run in a main thread that can’t be blocked.

pub fn sync(&self) -> ApiResult<Vec<String>>

Sync collections for all active clients

pub fn update_config(&self, config: RemoteSettingsConfig2) -> ApiResult<()>

Update the remote settings config

This will cause all current and future clients to use new config and will delete any stored records causing the clients to return new results from the new config.

Only intended for QA/debugging. Swapping the remote settings server in the middle of execution can cause weird effects.

Trait Implementations

impl<UT> LiftRef<UT> for RemoteSettingsService

type LiftType = Arc<RemoteSettingsService>

impl<UT> LowerError<UT> for RemoteSettingsService

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RemoteSettingsService

type ReturnType = <Arc<RemoteSettingsService> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for RemoteSettingsService

const TYPE_ID_META: MetadataBuffer = _