Struct SearchInfo 

#[non_exhaustive]
pub struct SearchInfo {
    pub search_query: String,
    pub order_by: String,
    pub offset: Option<i32>,
    /* private fields */
}

Available on crate features recommendation-service or user-event-service only.

Detailed search information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

search_query: String

The user’s search query.

See SearchRequest.query for definition.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

At least one of search_query or PageInfo.page_category is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

order_by: String

The order in which products are returned, if applicable.

See SearchRequest.order_by for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

offset: Option<i32>

An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).

See SearchRequest.offset for definition.

If this field is negative, an INVALID_ARGUMENT is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

Implementations

impl SearchInfo

pub fn new() -> Self

pub fn set_search_query<T: Into<String>>(self, v: T) -> Self

Sets the value of search_query.

Example

let x = SearchInfo::new().set_search_query("example");

pub fn set_order_by<T: Into<String>>(self, v: T) -> Self

Sets the value of order_by.

Example

let x = SearchInfo::new().set_order_by("example");

pub fn set_offset<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of offset.

Example

let x = SearchInfo::new().set_offset(42);

pub fn set_or_clear_offset<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of offset.

Example

let x = SearchInfo::new().set_or_clear_offset(Some(42));
let x = SearchInfo::new().set_or_clear_offset(None::<i32>);

Trait Implementations

impl Clone for SearchInfo

fn clone(&self) -> SearchInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchInfo

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

Formats the value using the given formatter.

impl Default for SearchInfo

fn default() -> SearchInfo

Returns the “default value” for a type.

impl Message for SearchInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchInfo

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