Struct RemoteSettings

pub struct RemoteSettings {
    pub config: RemoteSettingsConfig,
    /* private fields */
}

Fields

config: RemoteSettingsConfig

Implementations

impl RemoteSettings

pub fn new(remote_settings_config: RemoteSettingsConfig) -> ApiResult<Self>

Construct a new Remote Settings client with the given configuration.

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

Fetch all records for the configuration this client was initialized with.

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

Fetch all records added to the server since the provided timestamp, using the configuration this client was initialized with.

pub fn download_attachment_to_path( &self, attachment_id: String, path: String, ) -> ApiResult<()>

Download an attachment with the provided id to the provided path.

impl RemoteSettings

pub fn get_records_raw(&self) -> ApiResult<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 viaduct [Response].

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

Trait Implementations

impl<UT> LiftRef<UT> for RemoteSettings

type LiftType = Arc<RemoteSettings>

impl<UT> LowerError<UT> for RemoteSettings

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RemoteSettings

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

const TYPE_ID_META: MetadataBuffer