Struct QueryOptions 

#[non_exhaustive]
pub struct QueryOptions {
    pub limit_items: Option<u32>,
    pub after: Option<Bytes>,
    pub before: Option<Bytes>,
    pub ordering: i32,
}

Available on crate feature unstable only.

Cursor-bounded query options.

after and before are canonical ledger-position bounds, not ordering-relative cursors. after always excludes items at or below that cursor, and before always excludes items at or above that cursor. Ordering only controls the order of returned items within the resulting open interval.

For example, with after = A, before = B, ordering = DESCENDING, and limit_items = N, the response contains up to N matching items in descending order from the interval (A, B). If the response ends with QUERY_END_REASON_ITEM_LIMIT, resume by keeping after = A and setting before to the last Watermark.cursor (or last item cursor) received. That cursor is the lowest position reached in ledger order, so it becomes the next exclusive upper bound.

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.

limit_items: Option<u32>

The maximum number of items to return. Each method applies its own default and maximum. QueryEnd does not count against this limit.

after: Option<Bytes>

Opaque exclusive lower bound. Results must be strictly after this cursor in canonical ledger order.

before: Option<Bytes>

Opaque exclusive upper bound. Results must be strictly before this cursor in canonical ledger order.

ordering: i32

Ordering for returned results. Defaults to ASCENDING.

Ordering only controls the order of results within the bounded interval; cursor bounds keep the same meaning for ascending and descending reads.

Implementations

impl QueryOptions

pub const LIMIT_ITEMS_FIELD: &'static MessageField

pub const AFTER_FIELD: &'static MessageField

pub const BEFORE_FIELD: &'static MessageField

pub const ORDERING_FIELD: &'static MessageField

impl QueryOptions

pub fn path_builder() -> QueryOptionsFieldPathBuilder

impl QueryOptions

pub const fn const_default() -> Self

pub fn limit_items_opt_mut(&mut self) -> Option<&mut u32>

If limit_items is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn limit_items_mut(&mut self) -> &mut u32

Returns a mutable reference to limit_items. If the field is unset, it is first initialized with the default value.

pub fn limit_items_opt(&self) -> Option<u32>

If limit_items is set, returns Some with the value; otherwise returns None.

pub fn set_limit_items(&mut self, field: u32)

Sets limit_items with the provided value.

pub fn with_limit_items(self, field: u32) -> Self

Sets limit_items with the provided value.

pub fn after_opt(&self) -> Option<&[u8]>

If after is set, returns Some with the value; otherwise returns None.

pub fn set_after<T: Into<Bytes>>(&mut self, field: T)

Sets after with the provided value.

pub fn with_after<T: Into<Bytes>>(self, field: T) -> Self

Sets after with the provided value.

pub fn before_opt(&self) -> Option<&[u8]>

If before is set, returns Some with the value; otherwise returns None.

pub fn set_before<T: Into<Bytes>>(&mut self, field: T)

Sets before with the provided value.

pub fn with_before<T: Into<Bytes>>(self, field: T) -> Self

Sets before with the provided value.

impl QueryOptions

pub fn limit_items(&self) -> u32

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

pub fn after(&self) -> &[u8]

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

pub fn before(&self) -> &[u8]

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

pub fn ordering(&self) -> Ordering

Returns the enum value of ordering, or the default if the field is set to an invalid enum value.

pub fn set_ordering(&mut self, value: Ordering)

Sets ordering to the provided enum value.

Trait Implementations

impl Clone for QueryOptions

fn clone(&self) -> QueryOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryOptions

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

Formats the value using the given formatter.

impl Default for QueryOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryOptions

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for QueryOptions

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 Message for QueryOptions

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 MessageFields for QueryOptions

const FIELDS: &'static [&'static MessageField]

impl PartialEq for QueryOptions

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for QueryOptions

impl StructuralPartialEq for QueryOptions