Struct SearchV2Arg

#[non_exhaustive]
pub struct SearchV2Arg {
    pub query: String,
    pub options: Option<SearchOptions>,
    pub match_field_options: Option<SearchMatchFieldOptions>,
    pub include_highlights: Option<bool>,
}

Available on crate features sync_routes and dbx_files only.

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.

query: String

The string to search for. May match across multiple fields based on the request arguments.

options: Option<SearchOptions>

Options for more targeted search results.

match_field_options: Option<SearchMatchFieldOptions>

Options for search results match fields.

include_highlights: Option<bool>

Deprecated and moved this option to SearchMatchFieldOptions.

Implementations

impl SearchV2Arg

pub fn new(query: String) -> Self

pub fn with_options(self, value: SearchOptions) -> Self

pub fn with_match_field_options(self, value: SearchMatchFieldOptions) -> Self

pub fn with_include_highlights(self, value: bool) -> Self

Trait Implementations

impl Clone for SearchV2Arg

fn clone(&self) -> SearchV2Arg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchV2Arg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SearchV2Arg

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

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchV2Arg

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

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

Serialize this value into the given Serde serializer.

impl Eq for SearchV2Arg

impl StructuralPartialEq for SearchV2Arg