Struct ScrollPoints

pub struct ScrollPoints {
    pub collection_name: String,
    pub filter: Option<Filter>,
    pub offset: Option<PointId>,
    pub limit: Option<u32>,
    pub with_payload: Option<WithPayloadSelector>,
    pub with_vectors: Option<WithVectorsSelector>,
    pub read_consistency: Option<ReadConsistency>,
    pub shard_key_selector: Option<ShardKeySelector>,
    pub order_by: Option<OrderBy>,
    pub timeout: Option<u64>,
}

Fields

collection_name: String

filter: Option<Filter>

Filter conditions - return only those points that satisfy the specified conditions

offset: Option<PointId>

Start with this ID

limit: Option<u32>

Max number of result

with_payload: Option<WithPayloadSelector>

Options for specifying which payload to include or not

with_vectors: Option<WithVectorsSelector>

Options for specifying which vectors to include into response

read_consistency: Option<ReadConsistency>

Options for specifying read consistency guarantees

shard_key_selector: Option<ShardKeySelector>

Specify in which shards to look for the points, if not specified - look in all shards

order_by: Option<OrderBy>

Order the records by a payload field

timeout: Option<u64>

If set, overrides global timeout setting for this request. Unit is seconds.

Implementations

impl ScrollPoints

pub fn limit(&self) -> u32

Returns the value of limit, or the default value if limit is unset.

pub fn timeout(&self) -> u64

Returns the value of timeout, or the default value if timeout is unset.

Trait Implementations

impl Clone for ScrollPoints

fn clone(&self) -> ScrollPoints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollPoints

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

Formats the value using the given formatter.

impl Default for ScrollPoints

fn default() -> Self

Returns the “default value” for a type.

impl From<ScrollPointsBuilder> for ScrollPoints

fn from(value: ScrollPointsBuilder) -> Self

Converts to this type from the input type.

impl Message for ScrollPoints

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ScrollPoints

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