Struct RemoteSettingsContext

pub struct RemoteSettingsContext {
    pub channel: Option<String>,
    pub app_version: Option<String>,
    pub app_id: Option<String>,
    pub locale: Option<String>,
    pub os: Option<String>,
    pub os_version: Option<String>,
    pub form_factor: Option<String>,
    pub country: Option<String>,
    pub custom_targetting_attributes: Option<HashMap<String, String>>,
}

Remote settings context object

This is used to filter the records returned. We always fetch all records from the remote-settings storage. Some records could have a filter_expression. If this is passed in and the record has a filter_expression, then only returns where the expression is true will be returned.

See https://remote-settings.readthedocs.io/en/latest/target-filters.html for details.

Fields

channel: Option<String>

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

app_version: Option<String>

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

app_id: Option<String>

String containing the XUL application app_id

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”, “WINNT”)

os_version: Option<String>

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

form_factor: Option<String>

Form-factor of the device (“phone”, “tablet”, or “desktop”)

country: Option<String>

Country of the user.

This is usually populated in one of two ways:

• The second component of the locale
• By using a geolocation service, which determines country via the user’s IP. Firefox apps usually have a module that integrates with these services, for example Region on Desktop and RegionMiddleware on Android.

custom_targetting_attributes: Option<HashMap<String, String>>

Extra attributes to add to the env for JEXL filtering.

Use this for prototyping / testing new features. In the long-term, new fields should be added to the official list and supported by both the Rust and Gecko clients.

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<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<UT> TypeId<UT> for RemoteSettingsContext

const TYPE_ID_META: MetadataBuffer = _