Skip to main content

handle_query

Function handle_query 

Source
pub async fn handle_query<O: QueryObject, B: JmapBackend>(
    backend: &B,
    caller: &B::CallerCtx,
    args: Value,
) -> Result<HandlerOutput, JmapError>
Expand description

Generic */query handler (RFC 8620 §5.5).

Parses filter and sort from args as O::Filter and O::Comparator, and anchor/anchorOffset via query_anchor_args, then delegates to JmapReads::query_objects. A BackendQueryError::Method is returned to the client unchanged; any other backend error becomes the redacted serverFail.

Like handle_get it does not see using, so a non-null language (draft-atwood-jmap-updates-00 §4.2) is invalidArguments. A type with JmapObject::LOCALIZABLE properties uses handle_query_with_i18n or its own handler.

§Errors

Method-level errors, returned as the JmapError:

  • invalidArguments if args is not an object or accountId is missing or not a valid Id. Also when filter is not an object, sort is not an array of comparators, anchor or anchorOffset is malformed, position or limit has the wrong type, or language is non-null.
  • accountNotFound if the backend reports no such account; serverFail (with a redacted description) if that check fails.
  • unsupportedFilter if filter is an object that does not decode as the type’s filter.
  • A BackendQueryError::Method from the backend unchanged (for example unsupportedSort or anchorNotFound); any other backend error becomes the redacted serverFail.