Struct JSONEngineUrl 

pub struct JSONEngineUrl {
    pub base: Option<String>,
    pub method: Option<JSONEngineMethod>,
    pub params: Option<Vec<SearchUrlParam>>,
    pub search_term_param_name: Option<String>,
    pub display_name_map: Option<HashMap<String, 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. This is defined separately to types::SearchEngineUrl as various fields may be optional in the supplied configuration.

Fields

base: Option<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: Option<JSONEngineMethod>

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: Option<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_map: Option<HashMap<String, String>>

A map from locale codes to display names of the URL. This is useful if the URL corresponds to a brand name distinct from the engine’s brand name. Since brand names can be localized, this is a map rather than a URL. The client will fall back to the special locale code “default” when its locale is not present in the map.

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 this value is None, then it’s assumed the content type is irrelevant. 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 JSONEngineUrl

fn clone(&self) -> JSONEngineUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for JSONEngineUrl

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

impl Debug for JSONEngineUrl

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

Formats the value using the given formatter.

impl Default for JSONEngineUrl

fn default() -> JSONEngineUrl

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for JSONEngineUrl

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 JSONEngineUrl

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 JSONEngineUrl

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

type LiftType = JSONEngineUrl

impl<UT> LiftReturn<UT> for JSONEngineUrl

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

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

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for JSONEngineUrl

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

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

const TYPE_ID_META: MetadataBuffer

impl StructuralPartialEq for JSONEngineUrl