Struct DocumentSumRequest 

pub struct DocumentSumRequest<'a> {
    pub contract: &'a DataContract,
    pub document_type: DocumentTypeRef<'a>,
    pub sum_property: String,
    pub where_clauses: Vec<WhereClause>,
    pub order_clauses: Vec<OrderClause>,
    pub mode: SumMode,
    pub limit: Option<u32>,
    pub prove: bool,
    pub drive_config: &'a DriveConfig,
}

Server-side request input for the sum dispatcher. Mirrors crate::query::drive_document_count_query::DocumentCountRequest with the addition of the sum_property field.

Fields

contract: &'a DataContract

The data contract this document type belongs to.

document_type: DocumentTypeRef<'a>

The document type whose summable indexes will be picked from.

sum_property: String

The integer property to sum. Must match the doctype-level documents_summable (when set) and every covering index’s summable: "<x>" declaration; the dispatcher rejects mismatches at parse time.

where_clauses: Vec<WhereClause>

Structured where-clauses (parsed via drive_dispatcher::where_clauses_from_value from the wire-CBOR shape).

order_clauses: Vec<OrderClause>

Structured order-clauses (parsed via drive_dispatcher::order_clauses_from_value).

mode: SumMode

The sum mode requested.

limit: Option<u32>

Optional cap on the number of entries returned in Entries-mode responses.

Fallback differs between the no-proof and prove paths:

• No-proof path: unset limit falls back to crate::config::DriveConfig::default_query_limit (the operator-tunable runtime value); explicit limit > max_query_limit is clamped to max_query_limit. There’s no consensus-verification step on no-proof responses, so operator-tunable defaults are safe here.
• Prove path: unset limit falls back to crate::config::DEFAULT_QUERY_LIMIT (the compile-time constant the SDK verifier also reads), explicitly NOT drive_config.default_query_limit. An explicit limit > max_query_limit is rejected with crate::error::query::QuerySyntaxError::InvalidLimit rather than clamped, so a tuned operator default or an over-max request can’t byte-differ the SizedQuery::limit the SDK reconstructs for merk-root verification. See the drive_dispatcher’s RangeDistinctProof / RangeAggregateCarrierProof arms for the validate-don’t-clamp policy, mirrored from count’s prove-path arms.

prove: bool

Whether to return a Proof(Vec<u8>) instead of materializing the aggregate/entries server-side.

drive_config: &'a DriveConfig

Pointer to the drive config, used for limit defaults.

Trait Implementations

impl<'a> Clone for DocumentSumRequest<'a>

fn clone(&self) -> DocumentSumRequest<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DocumentSumRequest<'a>

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

Formats the value using the given formatter.