Struct RemoteSettingsClient

pub struct RemoteSettingsClient<C = ViaductApiClient> { /* private fields */ }

Internal Remote settings client API

This stores an ApiClient implementation. In the real-world, this is always ViaductApiClient, but the tests use a mock client.

Implementations

impl<C: ApiClient> RemoteSettingsClient<C>

pub fn new_from_parts( collection_name: String, storage: Storage, jexl_filter: JexlFilter, api_client: C, ) -> Self

pub fn collection_name(&self) -> &str

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

Get the current set of records.

If records are not present in storage this will normally return None. Use sync_if_empty = true to change this behavior and perform a network request in this case.

pub fn sync(&self) -> Result<()>

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

Downloads an attachment from [attachment_location]. NOTE: there are no guarantees about a maximum size, so use care when fetching potentially large attachments.

impl RemoteSettingsClient<ViaductApiClient>

pub fn new( server_url: Url, bucket_name: String, collection_name: String, context: Option<RemoteSettingsContext>, storage: Storage, ) -> Result<Self>

pub fn update_config(&self, server_url: Url, bucket_name: String) -> Result<()>