Struct PruneRequest 

pub struct PruneRequest {
    pub prune_up_to: i64,
    pub submission_id: String,
    pub prune_all_divulged_contracts: bool,
}

Fields

prune_up_to: i64

Inclusive valid absolute offset (positive integer) up to which the ledger is to be pruned. By default the following data is pruned:

1. All normal and divulged contracts that have been archived before prune_up_to.
2. All transaction events and completions before prune_up_to
3. All immediately divulged contracts created before prune_up_to independent of whether they were archived before prune_up_to.

Required

submission_id: String

Unique submission identifier. If not populated, defaults to a random identifier, used for logging.

Optional

prune_all_divulged_contracts: bool

Deprecated flag used to prune all immediately and retroactively divulged contracts. It is a no-op since the divulged contracts are pruned along with the deactivated contracts.

Optional

Trait Implementations

impl Clone for PruneRequest

fn clone(&self) -> PruneRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PruneRequest

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

Formats the value using the given formatter.

impl Default for PruneRequest

fn default() -> PruneRequest

Returns the “default value” for a type.

impl Eq for PruneRequest

impl Hash for PruneRequest

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for PruneRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PruneRequest

fn eq(&self, other: &PruneRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PruneRequest