Struct QueryResponse 

#[non_exhaustive]
pub struct QueryResponse {
    pub account_id: Id,
    pub query_state: State,
    pub can_calculate_changes: bool,
    pub position: u64,
    pub ids: Vec<Id>,
    pub total: Option<u64>,
    pub limit: Option<u64>,
    pub extra: Map<String, Value>,
}

RFC 8620 §5.5 — Foo/query response shape.

Returns the ids of objects matching a filter, in sort order. The query_state token can be passed to Foo/queryChanges to retrieve only the delta against this snapshot.

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.

account_id: Id

The account the response refers to.

query_state: State

Opaque state token for this query result; pass to /queryChanges.

can_calculate_changes: bool

true if /queryChanges will give incremental updates against this query_state; false if the client must re-run /query to refresh.

position: u64

Zero-based offset within the full result set of the first id in ids. Per RFC 8620 §5.5, may differ from the requested position when the requested offset exceeds the result count.

ids: Vec<Id>

The matching ids in sort order.

total: Option<u64>

Total number of matching objects, or None when the request did not set calculateTotal: true.

limit: Option<u64>

Server’s max page size; None when not advertised.

extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Trait Implementations

impl Clone for QueryResponse

fn clone(&self) -> QueryResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QueryResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.