nimbus::stateful::matcher

Struct AppContext

Source
pub struct AppContext {
Show 16 fields 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>>,
}
Expand description

The AppContext object represents the parameters and characteristics of the consuming application that we are interested in for targeting purposes. The app_name and channel fields are not optional as they are expected to be provided by all consuming applications as they are used in the top-level targeting that help to ensure that an experiment is only processed by the correct application.

Definitions of the fields are as follows:

  • app_name: This is the name of the application (e.g. “Fenix” or “Firefox iOS”)
  • app_id: This is the application identifier, especially for mobile (e.g. “org.mozilla.fenix”)
  • channel: This is the delivery channel of the application (e.g “nightly”)
  • app_version: The user visible version string (e.g. “1.0.3”)
  • app_build: The build identifier generated by the CI system (e.g. “1234/A”)
  • architecture: The architecture of the device, (e.g. “arm”, “x86”)
  • device_manufacturer: The manufacturer of the device the application is running on
  • device_model: The model of the device the application is running on
  • locale: The locale of the application during initialization (e.g. “es-ES”)
  • os: The name of the operating system (e.g. “Android”, “iOS”, “Darwin”, “Windows”)
  • os_version: The user-visible version of the operating system (e.g. “1.2.3”)
  • android_sdk_version: Android specific for targeting specific sdk versions
  • debug_tag: Used for debug purposes as a way to match only developer builds, etc.
  • installation_date: The date the application installed the app
  • home_directory: The application’s home directory
  • custom_targeting_attributes: Contains attributes specific to the application, derived by the application

Fields§

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

Trait Implementations§

Source§

impl Clone for AppContext

Source§

fn clone(&self) -> AppContext

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<UT> ConvertError<UT> for AppContext

Source§

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

Source§

impl Debug for AppContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AppContext

Source§

fn default() -> AppContext

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AppContext

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<UT> FfiConverter<UT> for AppContext

Source§

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].
Source§

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI. Read more
Source§

fn lower(v: Self) -> RustBuffer

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

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

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

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

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

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

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

impl From<AppContext> for TargetingAttributes

Source§

fn from(app_context: AppContext) -> Self

Converts to this type from the input type.
Source§

impl<UT> Lift<UT> for AppContext

Source§

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

Source§

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

Source§

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

§

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

Convenience method
Source§

impl<UT> LiftRef<UT> for AppContext

Source§

impl<UT> LiftReturn<UT> for AppContext

Source§

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

FFI return type for trait interfaces
Source§

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 Read more
§

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result Read more
§

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error Read more
Source§

impl<UT> Lower<UT> for AppContext

Source§

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

Source§

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

Source§

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

§

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method
Source§

impl<UT> LowerError<UT> for AppContext

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for AppContext

Source§

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

The type that should be returned by scaffolding functions for this type. Read more
Source§

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call Read more
§

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts Read more
Source§

impl Serialize for AppContext

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<UT> TypeId<UT> for AppContext

Source§

const TYPE_ID_META: MetadataBuffer = _

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> EncodableKey for T
where T: Serialize,

§

fn to_bytes(&self) -> Result<Vec<u8>, DataError>

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T