Struct search::types::SearchEngineDefinition

pub struct SearchEngineDefinition {
    pub aliases: Vec<String>,
    pub classification: SearchEngineClassification,
    pub identifier: String,
    pub name: String,
    pub partner_code: Option<String>,
    pub telemetry_suffix: Option<String>,
    pub urls: SearchEngineUrls,
    pub order_hint: Option<u8>,
}

A definition for an individual search engine to be presented to the user.

Fields

aliases: Vec<String>

A list of aliases for this engine.

classification: SearchEngineClassification

The classification of search engine according to the main search types (e.g. general, shopping, travel, dictionary). Currently, only marking as a general search engine is supported. On Android, only general search engines may be selected as “default” search engines.

identifier: String

The identifier of the search engine. This is used as an internal identifier, e.g. for saving the user’s settings for the engine. It is also used to form the base telemetry id and may be extended by telemetrySuffix.

name: String

The user visible name of the search engine.

partner_code: Option<String>

The partner code for the engine. This will be inserted into parameters which include {partnerCode}.

telemetry_suffix: Option<String>

Optional suffix that is appended to the search engine identifier following a dash, i.e. <identifier>-<suffix>

urls: SearchEngineUrls

The URLs associated with the search engine.

order_hint: Option<u8>

A hint to the order that this engine should be in the engine list. This is derived from the engineOrders section of the search configuration. The higher the number, the nearer to the front it should be. If the number is not specified, other methods of sorting may be relied upon (e.g. alphabetical).

Trait Implementations

impl<UT> ConvertError<UT> for SearchEngineDefinition

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

impl Debug for SearchEngineDefinition

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for SearchEngineDefinition

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.

const TYPE_ID_META: MetadataBuffer = _

Type ID metadata, serialized into a [MetadataBuffer].

impl<UT> Lift<UT> for SearchEngineDefinition

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

type LiftType = SearchEngineDefinition

impl<UT> LiftReturn<UT> for SearchEngineDefinition

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SearchEngineDefinition

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

const TYPE_ID_META: MetadataBuffer = _