Struct RemoteSettingsClient

pub struct RemoteSettingsClient { /* private fields */ }

Client for a single Remote Settings collection

Use RemoteSettingsService::make_client to create these.

Implementations

impl RemoteSettingsClient

pub fn collection_name(&self) -> String

Collection this client is for

pub fn get_records( &self, sync_if_empty: bool, ) -> Option<Vec<RemoteSettingsRecord>>

Get the current set of records.

This method normally fetches records from the last sync. This means that it returns fast and does not make any network requests.

If records have not yet been synced it will return None. Use sync_if_empty = true to change this behavior and perform a network request in this case. That this is probably a bad idea if you want to fetch the setting in application startup or when building the UI.

None will also be returned on disk IO errors or other unexpected errors. The reason for this is that there is not much an application can do in this situation other than fall back to the same default handling as if records have not been synced.

Application-services schedules regular dumps of the server data for specific collections. For these collections, get_records will never return None. If you would like to add your collection to this list, please reach out to the DISCO team.

pub fn get_records_map( &self, sync_if_empty: bool, ) -> Option<HashMap<String, RemoteSettingsRecord>>

Get the current set of records as a map of record_id -> record.

See Self::get_records for an explanation of when this makes network requests, error handling, and how the sync_if_empty param works.

pub fn get_attachment(&self, record: RemoteSettingsRecord) -> ApiResult<Vec<u8>>

Get attachment data for a remote settings record

Attachments are large binary blobs used for data that doesn’t fit in a normal record. They are handled differently than other record data:

• Attachments are not downloaded in RemoteSettingsService::sync
• This method will make network requests if the attachment is not cached
• This method will throw if there is a network or other error when fetching the attachment data.

Trait Implementations

impl<UT> LiftRef<UT> for RemoteSettingsClient

type LiftType = Arc<RemoteSettingsClient>

impl<UT> LowerError<UT> for RemoteSettingsClient

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RemoteSettingsClient

type ReturnType = <Arc<RemoteSettingsClient> 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 RemoteSettingsClient

const TYPE_ID_META: MetadataBuffer = _