Struct GetActiveContractsRequest 

pub struct GetActiveContractsRequest {
    pub filter: Option<Box<TransactionFilter>>,
    pub verbose: bool,
    pub active_at_offset: i64,
    pub event_format: Option<Box<EventFormat>>,
}

GetActiveContractsRequest : If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset, the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED". Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party migration is not concerned with incomplete (un)assignments.

Fields

filter: Option<Box<TransactionFilter>>

verbose: bool

Provided for backwards compatibility, it will be removed in the Canton version 3.4.0. If enabled, values served over the API will contain more information than strictly necessary to interpret the data. In particular, setting the verbose flag to true triggers the ledger to include labels for record fields. Optional, if specified event_format must be unset.

active_at_offset: i64

The offset at which the snapshot of the active contracts will be computed. Must be no greater than the current ledger end offset. Must be greater than or equal to the last pruning offset. Required, must be a valid absolute offset (positive integer) or ledger begin offset (zero). If zero, the empty set will be returned.

event_format: Option<Box<EventFormat>>

Implementations

impl GetActiveContractsRequest

pub fn new(verbose: bool, active_at_offset: i64) -> GetActiveContractsRequest

If the given offset is different than the ledger end, and there are (un)assignments in-flight at the given offset, the snapshot may fail with "FAILED_PRECONDITION/PARTICIPANT_PRUNED_DATA_ACCESSED". Note that it is ok to request acs snapshots for party migration with offsets other than ledger end, because party migration is not concerned with incomplete (un)assignments.

Trait Implementations

impl Clone for GetActiveContractsRequest

fn clone(&self) -> GetActiveContractsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetActiveContractsRequest

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

Formats the value using the given formatter.

impl Default for GetActiveContractsRequest

fn default() -> GetActiveContractsRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetActiveContractsRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GetActiveContractsRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetActiveContractsRequest