Struct UpdatesRequest 

pub struct UpdatesRequest { /* private fields */ }

A builder for CantonClient::updates_with / CantonClient::updates_resumable_with: the update stream with the full request surface exposed.

Implementations

impl UpdatesRequest

pub fn new(parties: Vec<String>, begin_exclusive: i64) -> Self

Updates visible to parties, starting after begin_exclusive. The defaults beyond that are the plain updates ones: unbounded, ledger-effects shape, all templates, reassignments included, verbose (labelled) records.

pub fn until(self, end_inclusive: i64) -> Self

Bound the stream: only updates at offsets <= end_inclusive, after which the stream ends. This is the catch-up/sync-tool form — without it the stream is live and never terminates.

pub fn descending(self) -> Self

Return updates in descending offset order (newest first). Requires a bounded request (Self::until); rejected on the resumable stream, whose position tracking assumes ascending order.

pub fn for_any_party(self) -> Self

Additionally apply this request’s filter set for any party the token can read for (filters_for_any_party) — the full-ledger ingestion form. Requires wildcard read authorization on the participant; the explicit parties list (which may be empty) is still applied on top.

pub fn with_shape(self, shape: TransactionShape) -> Self

Select the transaction shape (default: ledger effects).

pub fn for_templates<I, S>(self, template_ids: I) -> Result<Self>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Only events of these templates. Each id is package:Module:Entity, where package is a package id or a #package-name reference (the SCU-friendly form). May be combined with Self::for_interfaces; each call adds to the filter.

Errors

Returns Error::InvalidRequest on a malformed id.

pub fn for_interfaces<I, S>(self, interface_ids: I) -> Result<Self>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Only events of contracts implementing these interfaces (the returned created events carry the interface views). Same id format and accumulation as Self::for_templates.

Errors

Returns Error::InvalidRequest on a malformed id.

pub fn with_created_event_blobs(self) -> Self

Include each created event’s created_event_blob, for use as a disclosed contract in later commands.

pub fn without_reassignments(self) -> Self

Exclude reassignment events (included by default).

pub fn with_topology_events(self) -> Self

Include participant-authorization topology events for the requested parties (excluded by default).

pub fn non_verbose(self) -> Self

Omit record labels from the returned values (verbose is the default). Non-verbose payloads are smaller; typed decoding handles both.

Trait Implementations

impl Clone for UpdatesRequest

fn clone(&self) -> UpdatesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdatesRequest

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

Formats the value using the given formatter.