Struct firestore_grpc::google::firestore::v1::structured_query::FindNearest
source · pub struct FindNearest {
pub vector_field: Option<FieldReference>,
pub query_vector: Option<Value>,
pub distance_measure: i32,
pub limit: Option<i32>,
}
Expand description
Nearest Neighbors search config.
Fields§
§vector_field: Option<FieldReference>
Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
query_vector: Option<Value>
Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
distance_measure: i32
Required. The Distance Measure to use, required.
limit: Option<i32>
Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
Implementations§
source§impl FindNearest
impl FindNearest
sourcepub fn distance_measure(&self) -> DistanceMeasure
pub fn distance_measure(&self) -> DistanceMeasure
Returns the enum value of distance_measure
, or the default if the field is set to an invalid enum value.
sourcepub fn set_distance_measure(&mut self, value: DistanceMeasure)
pub fn set_distance_measure(&mut self, value: DistanceMeasure)
Sets distance_measure
to the provided enum value.
Trait Implementations§
source§impl Clone for FindNearest
impl Clone for FindNearest
source§fn clone(&self) -> FindNearest
fn clone(&self) -> FindNearest
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for FindNearest
impl Debug for FindNearest
source§impl Default for FindNearest
impl Default for FindNearest
source§impl Message for FindNearest
impl Message for FindNearest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
Returns the encoded length of the message without a length delimiter.
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>
Encodes the message to a buffer. Read more
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message to a newly allocated buffer.
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>
Encodes the message with a length-delimiter to a buffer. Read more
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
Encodes the message with a length-delimiter to a newly allocated buffer.
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>
fn decode<B>(buf: B) -> Result<Self, DecodeError>
Decodes an instance of the message from a buffer. Read more
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>
Decodes a length-delimited instance of the message from the buffer.
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>
Decodes an instance of the message from a buffer, and merges it into
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>
Decodes a length-delimited instance of the message from buffer, and
merges it into
self
.source§impl PartialEq for FindNearest
impl PartialEq for FindNearest
source§fn eq(&self, other: &FindNearest) -> bool
fn eq(&self, other: &FindNearest) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for FindNearest
Auto Trait Implementations§
impl Freeze for FindNearest
impl RefUnwindSafe for FindNearest
impl Send for FindNearest
impl Sync for FindNearest
impl Unpin for FindNearest
impl UnwindSafe for FindNearest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T
in a tonic::Request