Struct SearchHint 

#[non_exhaustive]
pub struct SearchHint {
    pub index_type: Option<IndexType>,
    /* private fields */
}

Represents a hint to the search index engine.

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.

index_type: Option<IndexType>

The type of index to use.

Implementations

impl SearchHint

pub fn new() -> Self

pub fn set_index_type<T: Into<Option<IndexType>>>(self, v: T) -> Self

Sets the value of index_type.

Note that all the setters affecting index_type are mutually exclusive.

Example

use google_cloud_vectorsearch_v1::model::search_hint::KnnHint;
let x = SearchHint::new().set_index_type(Some(
    google_cloud_vectorsearch_v1::model::search_hint::IndexType::KnnHint(KnnHint::default().into())));

pub fn knn_hint(&self) -> Option<&Box<KnnHint>>

The value of index_type if it holds a KnnHint, None if the field is not set or holds a different branch.

pub fn set_knn_hint<T: Into<Box<KnnHint>>>(self, v: T) -> Self

Sets the value of index_type to hold a KnnHint.

Note that all the setters affecting index_type are mutually exclusive.

Example

use google_cloud_vectorsearch_v1::model::search_hint::KnnHint;
let x = SearchHint::new().set_knn_hint(KnnHint::default()/* use setters */);
assert!(x.knn_hint().is_some());
assert!(x.index_hint().is_none());

pub fn index_hint(&self) -> Option<&Box<IndexHint>>

The value of index_type if it holds a IndexHint, None if the field is not set or holds a different branch.

pub fn set_index_hint<T: Into<Box<IndexHint>>>(self, v: T) -> Self

Sets the value of index_type to hold a IndexHint.

Note that all the setters affecting index_type are mutually exclusive.

Example

use google_cloud_vectorsearch_v1::model::search_hint::IndexHint;
let x = SearchHint::new().set_index_hint(IndexHint::default()/* use setters */);
assert!(x.index_hint().is_some());
assert!(x.knn_hint().is_none());

Trait Implementations

impl Clone for SearchHint

fn clone(&self) -> SearchHint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchHint

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

Formats the value using the given formatter.

impl Default for SearchHint

fn default() -> SearchHint

Returns the “default value” for a type.

impl Message for SearchHint

fn typename() -> &'static str

The typename of this message.

impl PartialEq for SearchHint

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