Struct SearchEngineUrl

pub struct SearchEngineUrl {
    pub base: String,
    pub method: String,
    pub params: Vec<SearchUrlParam>,
    pub search_term_param_name: Option<String>,
    pub display_name: Option<String>,
    pub is_new_until: Option<String>,
    pub exclude_partner_code_from_telemetry: bool,
    pub accepted_content_types: Option<Vec<String>>,
}

Defines an individual search engine URL.

Fields

base: String

The PrePath and FilePath of the URL. May include variables for engines which have a variable FilePath, e.g. {searchTerms} for when a search term is within the path of the url.

method: String

The HTTP method to use to send the request (GET or POST). If the engine definition has not specified the method, it defaults to GET.

params: Vec<SearchUrlParam>

The parameters for this URL.

search_term_param_name: Option<String>

The name of the query parameter for the search term. Automatically appended to the end of the query. This may be skipped if {searchTerms} is included in the base.

display_name: Option<String>

The display name of the URL, if any. This is useful if the URL corresponds to a brand name distinct from the engine’s brand name.

is_new_until: Option<String>

Indicates the date until which the URL is considered new (format: YYYY-MM-DD).

exclude_partner_code_from_telemetry: bool

Whether the engine’s partner code should be excluded from telemetry when this URL is visited.

accepted_content_types: Option<Vec<String>>

If this URL performs searches only for certain MIME types, they should be listed here. If None, it’s assumed the content type is text or not relevant. This field is intended to be used for URLs like visual search, which might support certain image types and not others. Consumers can use it to determine whether search UI corresponding to the URL should be shown to the user in a given context.

Trait Implementations

impl Clone for SearchEngineUrl

fn clone(&self) -> SearchEngineUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for SearchEngineUrl

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

impl Debug for SearchEngineUrl

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

Formats the value using the given formatter.

impl Default for SearchEngineUrl

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchEngineUrl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for SearchEngineUrl

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 SearchEngineUrl

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

type LiftType = SearchEngineUrl

impl<UT> LiftReturn<UT> for SearchEngineUrl

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for SearchEngineUrl

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

fn eq(&self, other: &SearchEngineUrl) -> 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 SearchEngineUrl

const TYPE_ID_META: MetadataBuffer

impl StructuralPartialEq for SearchEngineUrl