Struct RemoteSettingsContext

pub struct RemoteSettingsContext {

    pub app_name: String,
    pub app_id: String,
    pub channel: String,
    pub app_version: Option<String>,
    pub app_build: Option<String>,
    pub architecture: Option<String>,
    pub device_manufacturer: Option<String>,
    pub device_model: Option<String>,
    pub locale: Option<String>,
    pub os: Option<String>,
    pub os_version: Option<String>,
    pub android_sdk_version: Option<String>,
    pub debug_tag: Option<String>,
    pub installation_date: Option<i64>,
    pub home_directory: Option<String>,
    pub custom_targeting_attributes: Option<Map<String, Value>>,
}

The RemoteSettingsContext object represents the parameters and characteristics of the consuming application. For remote-settings, it is used to filter locally stored records.

We always fetch all records from the remote-settings storage. Some records could have a filter_expression attached to them, which will be matched against the RemoteSettingsContext.

When set, only records where the expression is true will be returned.

Fields

app_name: String

Name of the application (e.g. “Fenix” or “Firefox iOS”)

app_id: String

Application identifier, especially for mobile (e.g. “org.mozilla.fenix”)

channel: String

The delivery channel of the application (e.g “nightly”)

app_version: Option<String>

User visible version string (e.g. “1.0.3”)

app_build: Option<String>

Build identifier generated by the CI system (e.g. “1234/A”)

architecture: Option<String>

The architecture of the device, (e.g. “arm”, “x86”)

device_manufacturer: Option<String>

The manufacturer of the device the application is running on

device_model: Option<String>

The model of the device the application is running on

locale: Option<String>

The locale of the application during initialization (e.g. “es-ES”)

os: Option<String>

The name of the operating system (e.g. “Android”, “iOS”, “Darwin”, “Windows”)

os_version: Option<String>

The user-visible version of the operating system (e.g. “1.2.3”)

android_sdk_version: Option<String>

Android specific for targeting specific sdk versions

debug_tag: Option<String>

Used for debug purposes as a way to match only developer builds, etc.

installation_date: Option<i64>

The date the application installed the app

home_directory: Option<String>

The application’s home directory

custom_targeting_attributes: Option<Map<String, Value>>

Contains attributes specific to the application, derived by the application

Trait Implementations

impl Clone for RemoteSettingsContext

fn clone(&self) -> RemoteSettingsContext

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for RemoteSettingsContext

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for RemoteSettingsContext

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RemoteSettingsContext

fn default() -> RemoteSettingsContext

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RemoteSettingsContext

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for RemoteSettingsContext

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl<UT> Lift<UT> for RemoteSettingsContext

type FfiType = <RemoteSettingsContext as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for RemoteSettingsContext

type LiftType = RemoteSettingsContext

impl<UT> LiftReturn<UT> for RemoteSettingsContext

type ReturnType = <RemoteSettingsContext as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for RemoteSettingsContext

type FfiType = <RemoteSettingsContext as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for RemoteSettingsContext

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RemoteSettingsContext

type ReturnType = <RemoteSettingsContext as Lower<UT>>::FfiType

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

fn lower_return(v: 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 Serialize for RemoteSettingsContext

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for RemoteSettingsContext

const TYPE_ID_META: MetadataBuffer = _