Struct RefinedSearchConfig

pub struct RefinedSearchConfig {
    pub engines: Vec<SearchEngineDefinition>,
    pub app_default_engine_id: Option<String>,
    pub app_private_default_engine_id: Option<String>,
}

Details of the search engines to display to the user, generated as a result of processing the search configuration.

Fields

engines: Vec<SearchEngineDefinition>

A sorted list of engines. Clients may use the engine in the order that this list is specified, or they may implement their own order if they have other requirements.

The application default engines should not be assumed from this order in case of future changes.

The sort order is:

• Application Default Engine
• Application Default Engine for Private Mode (if specified & different)
• Engines sorted by descending SearchEngineDefinition.orderHint
• Any other engines in alphabetical order (locale based comparison)

app_default_engine_id: Option<String>

The identifier of the engine that should be used for the application default engine. If this is undefined, an error has occurred, and the application should either default to the first engine in the engines list or otherwise handle appropriately.

app_private_default_engine_id: Option<String>

If specified, the identifier of the engine that should be used for the application default engine in private browsing mode. Only desktop uses this currently.

Trait Implementations

impl<UT> ConvertError<UT> for RefinedSearchConfig

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

impl Debug for RefinedSearchConfig

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for RefinedSearchConfig

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 RefinedSearchConfig

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

type LiftType = RefinedSearchConfig

impl<UT> LiftReturn<UT> for RefinedSearchConfig

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for RefinedSearchConfig

type ReturnType = <RefinedSearchConfig 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 PartialEq for RefinedSearchConfig

fn eq(&self, other: &RefinedSearchConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UT> TypeId<UT> for RefinedSearchConfig

const TYPE_ID_META: MetadataBuffer = _

impl StructuralPartialEq for RefinedSearchConfig