Struct SearchUserEnvironment

pub struct SearchUserEnvironment {
    pub locale: String,
    pub region: String,
    pub update_channel: SearchUpdateChannel,
    pub distribution_id: String,
    pub experiment: String,
    pub app_name: SearchApplicationName,
    pub version: String,
    pub device_type: SearchDeviceType,
}

The user’s environment that is used for filtering the search configuration.

Fields

locale: String

The current locale of the application that the user is using.

region: String

The home region that the user is currently identified as being within. On desktop & android there is a 14 day lag after detecting a region change before the home region changes. TBD: iOS?

update_channel: SearchUpdateChannel

The update channel of the user’s build.

distribution_id: String

The distribution id for the user’s build.

experiment: String

The search related experiment id that the user is included within. On desktop this is the searchConfiguration.experiment variable.

app_name: SearchApplicationName

The application name that the user is using.

version: String

The application version that the user is using.

device_type: SearchDeviceType

The device type that the user is using.

Trait Implementations

impl Clone for SearchUserEnvironment

fn clone(&self) -> SearchUserEnvironment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for SearchUserEnvironment

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

impl Debug for SearchUserEnvironment

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

Formats the value using the given formatter.

impl Default for SearchUserEnvironment

fn default() -> SearchUserEnvironment

Returns the “default value” for a type.

impl<UT> FfiConverter<UT> for SearchUserEnvironment

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 SearchUserEnvironment

type FfiType = <SearchUserEnvironment 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 SearchUserEnvironment

type LiftType = SearchUserEnvironment

impl<UT> LiftReturn<UT> for SearchUserEnvironment

type ReturnType = <SearchUserEnvironment 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 SearchUserEnvironment

type FfiType = <SearchUserEnvironment 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 SearchUserEnvironment

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SearchUserEnvironment

type ReturnType = <SearchUserEnvironment 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 SearchUserEnvironment

const TYPE_ID_META: MetadataBuffer = _