Struct Client

pub struct Client { /* private fields */ }

A simple HTTP client that can retrieve Remote Settings data using the properties by [ClientConfig]. Methods defined on this will fetch data from <base_url>/buckets/<bucket_name>/collections/<collection_name>/

Implementations

impl Client

pub fn new(config: RemoteSettingsConfig) -> Result<Self>

Create a new Client with properties matching config.

pub fn get_records(&self) -> Result<RemoteSettingsResponse>

Fetches all records for a collection that can be found in the server, bucket, and collection defined by the [ClientConfig] used to generate this Client.

pub fn get_records_raw(&self) -> Result<Response>

Fetches all records for a collection that can be found in the server, bucket, and collection defined by the [ClientConfig] used to generate this Client. This function will return the raw network [Response].

pub fn get_records_since( &self, timestamp: u64, ) -> Result<RemoteSettingsResponse>

Fetches all records that have been published since provided timestamp for a collection that can be found in the server, bucket, and collection defined by the [ClientConfig] used to generate this Client.

pub fn get_records_with_options( &self, options: &GetItemsOptions, ) -> Result<RemoteSettingsResponse>

Fetches records from this client’s collection with the given options.

pub fn get_records_raw_with_options( &self, options: &GetItemsOptions, ) -> Result<Response>

Fetches a raw network [Response] for records from this client’s collection with the given options.

pub fn get_attachment(&self, attachment_location: &str) -> 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.

pub fn get_attachment_raw(&self, attachment_location: &str) -> Result<Response>

Fetches a raw network [Response] for an attachment.