Struct ScrollRequest 

pub struct ScrollRequest {
    pub offset: Option<ExtendedPointId>,
    pub limit: Option<usize>,
    pub filter: Option<Filter>,
    pub with_payload: Option<WithPayloadInterface>,
    pub with_vector: WithVector,
    pub order_by: Option<OrderByInterface>,
}

Scroll request - paginate over all points which matches given condition

Fields

offset: Option<ExtendedPointId>

Start ID to read points from.

limit: Option<usize>

Page size. Default: 10

filter: Option<Filter>

Look only for points which satisfies this conditions. If not provided - all points.

with_payload: Option<WithPayloadInterface>

Select which payload to return with the response. Default is true.

with_vector: WithVector

Options for specifying which vectors to include into response. Default is false.

order_by: Option<OrderByInterface>

Order the records by a payload field.

Implementations

impl ScrollRequestInternal

pub const fn default_limit() -> usize

pub const fn default_with_payload() -> WithPayloadInterface

pub const fn default_with_vector() -> WithVector

Trait Implementations

impl Clone for ScrollRequestInternal

fn clone(&self) -> ScrollRequestInternal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollRequestInternal

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

Formats the value using the given formatter.

impl Default for ScrollRequestInternal

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScrollRequestInternal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ScrollRequestInternal

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for ScrollRequestInternal

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ScrollRequestInternal

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for ScrollRequestInternal

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for ScrollRequestInternal

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl StructuralPartialEq for ScrollRequestInternal