Struct merino_suggest_traits::Suggestion

source · [−]

pub struct Suggestion {
    pub id: u32,
    pub full_keyword: String,
    pub title: String,
    pub url: Uri,
    pub impression_url: Option<Uri>,
    pub click_url: Option<Uri>,
    pub provider: String,
    pub advertiser: String,
    pub is_sponsored: bool,
    pub icon: Uri,
    pub score: Proportion,
}

Expand description

A suggestion to provide to a user.

Fields

id: u32

The content provider ID of the suggestion.

full_keyword: String

If this suggestion can be matched with partial keywords this is the full keyword of the suggestion.

title: String

The title to display to the user.

url: Uri

The URL to send the user to if they select this suggestion.

impression_url: Option<Uri>

The URL to notify when this keyword is presented to a user.

click_url: Option<Uri>

The URL to notify when this keyword is clicked on by a user.

provider: String

The name of the provider associated with this suggestion.

advertiser: String

The name of the advertiser associated with this suggestion.

is_sponsored: bool

Whether this suggestion is sponsored.

icon: Uri

The URL of the icon to show along side this suggestion.

score: Proportion

A value used to compare suggestions. When choosing a suggestion to show the user, higher scored suggestions are preferred. Should range from 0.0 to 1.0.

Note that Firefox uses a static value of 0.2 for Remote Settings provided suggestions.

Trait Implementations

impl Clone for Suggestion

fn clone(&self) -> Suggestion

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Suggestion

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for Suggestion

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<F> Dummy<F> for Suggestion

fn dummy_with_rng<R: Rng + ?Sized>(_config: &F, rng: &mut R) -> Self

fn dummy(config: &T) -> Self

impl Hash for Suggestion

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

impl PartialEq<Suggestion> for Suggestion

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

This method tests for self and other values to be equal, and is used by ==. Read more

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

This method tests for !=.

impl Serialize for Suggestion

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Eq for Suggestion

impl StructuralEq for Suggestion

impl StructuralPartialEq for Suggestion

Auto Trait Implementations

impl RefUnwindSafe for Suggestion

impl Send for Suggestion

impl Sync for Suggestion

impl Unpin for Suggestion

impl UnwindSafe for Suggestion

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> CallHasher for T where
T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> Fake for T

fn fake<U>(&self) -> U where
Self: FakeBase<U>,

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U where
R: Rng + ?Sized,
Self: FakeBase<U>,

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,