Struct Checkpoint

#[non_exhaustive]
pub struct Checkpoint {
    pub sequence_number: Option<u64>,
    pub digest: Option<String>,
    pub summary: Option<CheckpointSummary>,
    pub signature: Option<ValidatorAggregatedSignature>,
    pub contents: Option<CheckpointContents>,
    pub transactions: Vec<ExecutedTransaction>,
    pub objects: Option<ObjectSet>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sequence_number: Option<u64>

The height of this checkpoint.

digest: Option<String>

The digest of this Checkpoint’s CheckpointSummary.

summary: Option<CheckpointSummary>

The CheckpointSummary for this checkpoint.

signature: Option<ValidatorAggregatedSignature>

An aggregated quorum signature from the validator committee that certified this checkpoint.

contents: Option<CheckpointContents>

The CheckpointContents for this checkpoint.

transactions: Vec<ExecutedTransaction>

List of transactions included in this checkpoint.

objects: Option<ObjectSet>

Set of objects either referenced as inputs or produced as outputs by transactions included in this checkpoint.

In order to benefit from deduplication of objects that appear in multiple transactions in this checkpoint, objects will only be present here and the transactions.objects field will not be populated.

Implementations

impl Checkpoint

pub const SEQUENCE_NUMBER_FIELD: &'static MessageField

pub const DIGEST_FIELD: &'static MessageField

pub const SUMMARY_FIELD: &'static MessageField

pub const SIGNATURE_FIELD: &'static MessageField

pub const CONTENTS_FIELD: &'static MessageField

pub const TRANSACTIONS_FIELD: &'static MessageField

pub const OBJECTS_FIELD: &'static MessageField

impl Checkpoint

pub fn path_builder() -> CheckpointFieldPathBuilder

impl Checkpoint

pub const fn const_default() -> Self

pub fn sequence_number_opt_mut(&mut self) -> Option<&mut u64>

If sequence_number is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn sequence_number_mut(&mut self) -> &mut u64

Returns a mutable reference to sequence_number. If the field is unset, it is first initialized with the default value.

pub fn sequence_number_opt(&self) -> Option<u64>

If sequence_number is set, returns Some with the value; otherwise returns None.

pub fn set_sequence_number<T: Into<u64>>(&mut self, field: T)

Sets sequence_number with the provided value.

pub fn with_sequence_number<T: Into<u64>>(self, field: T) -> Self

Sets sequence_number with the provided value.

pub fn digest_opt_mut(&mut self) -> Option<&mut String>

If digest is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn digest_mut(&mut self) -> &mut String

Returns a mutable reference to digest. If the field is unset, it is first initialized with the default value.

pub fn digest_opt(&self) -> Option<&str>

If digest is set, returns Some with the value; otherwise returns None.

pub fn set_digest<T: Into<String>>(&mut self, field: T)

Sets digest with the provided value.

pub fn with_digest<T: Into<String>>(self, field: T) -> Self

Sets digest with the provided value.

pub fn summary(&self) -> &CheckpointSummary

Returns the value of summary, or the default value if summary is unset.

pub fn summary_opt_mut(&mut self) -> Option<&mut CheckpointSummary>

If summary is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn summary_mut(&mut self) -> &mut CheckpointSummary

Returns a mutable reference to summary. If the field is unset, it is first initialized with the default value.

pub fn summary_opt(&self) -> Option<&CheckpointSummary>

If summary is set, returns Some with the value; otherwise returns None.

pub fn set_summary<T: Into<CheckpointSummary>>(&mut self, field: T)

Sets summary with the provided value.

pub fn with_summary<T: Into<CheckpointSummary>>(self, field: T) -> Self

Sets summary with the provided value.

pub fn signature(&self) -> &ValidatorAggregatedSignature

Returns the value of signature, or the default value if signature is unset.

pub fn signature_opt_mut(&mut self) -> Option<&mut ValidatorAggregatedSignature>

If signature is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn signature_mut(&mut self) -> &mut ValidatorAggregatedSignature

Returns a mutable reference to signature. If the field is unset, it is first initialized with the default value.

pub fn signature_opt(&self) -> Option<&ValidatorAggregatedSignature>

If signature is set, returns Some with the value; otherwise returns None.

pub fn set_signature<T: Into<ValidatorAggregatedSignature>>(&mut self, field: T)

Sets signature with the provided value.

pub fn with_signature<T: Into<ValidatorAggregatedSignature>>( self, field: T, ) -> Self

Sets signature with the provided value.

pub fn contents(&self) -> &CheckpointContents

Returns the value of contents, or the default value if contents is unset.

pub fn contents_opt_mut(&mut self) -> Option<&mut CheckpointContents>

If contents is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn contents_mut(&mut self) -> &mut CheckpointContents

Returns a mutable reference to contents. If the field is unset, it is first initialized with the default value.

pub fn contents_opt(&self) -> Option<&CheckpointContents>

If contents is set, returns Some with the value; otherwise returns None.

pub fn set_contents<T: Into<CheckpointContents>>(&mut self, field: T)

Sets contents with the provided value.

pub fn with_contents<T: Into<CheckpointContents>>(self, field: T) -> Self

Sets contents with the provided value.

pub fn transactions(&self) -> &[ExecutedTransaction]

Returns the value of transactions, or the default value if transactions is unset.

pub fn transactions_mut(&mut self) -> &mut Vec<ExecutedTransaction>

Returns a mutable reference to transactions. If the field is unset, it is first initialized with the default value.

pub fn set_transactions(&mut self, field: Vec<ExecutedTransaction>)

Sets transactions with the provided value.

pub fn with_transactions(self, field: Vec<ExecutedTransaction>) -> Self

Sets transactions with the provided value.

pub fn objects(&self) -> &ObjectSet

Returns the value of objects, or the default value if objects is unset.

pub fn objects_opt_mut(&mut self) -> Option<&mut ObjectSet>

If objects is set, returns Some with a mutable reference to the value; otherwise returns None.

pub fn objects_mut(&mut self) -> &mut ObjectSet

Returns a mutable reference to objects. If the field is unset, it is first initialized with the default value.

pub fn objects_opt(&self) -> Option<&ObjectSet>

If objects is set, returns Some with the value; otherwise returns None.

pub fn set_objects<T: Into<ObjectSet>>(&mut self, field: T)

Sets objects with the provided value.

pub fn with_objects<T: Into<ObjectSet>>(self, field: T) -> Self

Sets objects with the provided value.

impl Checkpoint

pub fn sequence_number(&self) -> u64

Returns the value of sequence_number, or the default value if sequence_number is unset.

pub fn digest(&self) -> &str

Returns the value of digest, or the default value if digest is unset.

Trait Implementations

impl Clone for Checkpoint

fn clone(&self) -> Checkpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Checkpoint

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

Formats the value using the given formatter.

impl Default for Checkpoint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Checkpoint

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Merge<&Checkpoint> for Checkpoint

fn merge(&mut self, source: &Checkpoint, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<&CheckpointSummary> for Checkpoint

fn merge(&mut self, source: &CheckpointSummary, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<CheckpointContents> for Checkpoint

fn merge(&mut self, source: CheckpointContents, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Merge<ValidatorAggregatedSignature> for Checkpoint

fn merge(&mut self, source: ValidatorAggregatedSignature, mask: &FieldMaskTree)

fn merge_from(source: T, mask: &FieldMaskTree) -> Self

where Self: Default,

impl Message for Checkpoint

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 MessageFields for Checkpoint

const FIELDS: &'static [&'static MessageField]

impl PartialEq for Checkpoint

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

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 Checkpoint