Struct GetCheckpointObjectProofResponse 

#[non_exhaustive]
pub struct GetCheckpointObjectProofResponse {
    pub checkpoint_summary: Option<Bytes>,
    pub proof: Option<Proof>,
}

Available on crate feature unstable only.

Response containing a checkpoint-object proof and the materials needed to verify it end-to-end.

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.

checkpoint_summary: Option<Bytes>

BCS-encoded CertifiedCheckpointSummary for the requested checkpoint, carrying the checkpoint_artifacts_digest that the proof’s tree_root must reconstruct, plus the BLS aggregate signature attesting to it.

proof: Option<Proof>

The proof itself: either an inclusion or a non-inclusion proof.

Implementations

impl GetCheckpointObjectProofResponse

pub const CHECKPOINT_SUMMARY_FIELD: &'static MessageField

pub const INCLUSION_FIELD: &'static MessageField

pub const NON_INCLUSION_FIELD: &'static MessageField

impl GetCheckpointObjectProofResponse

pub fn path_builder() -> GetCheckpointObjectProofResponseFieldPathBuilder

impl GetCheckpointObjectProofResponse

pub const fn const_default() -> Self

pub fn checkpoint_summary_opt(&self) -> Option<&[u8]>

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

pub fn set_checkpoint_summary<T: Into<Bytes>>(&mut self, field: T)

Sets checkpoint_summary with the provided value.

pub fn with_checkpoint_summary<T: Into<Bytes>>(self, field: T) -> Self

Sets checkpoint_summary with the provided value.

pub fn inclusion(&self) -> &OcsInclusionProof

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

pub fn inclusion_opt(&self) -> Option<&OcsInclusionProof>

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

pub fn inclusion_opt_mut(&mut self) -> Option<&mut OcsInclusionProof>

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

pub fn inclusion_mut(&mut self) -> &mut OcsInclusionProof

Returns a mutable reference to inclusion. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn set_inclusion<T: Into<OcsInclusionProof>>(&mut self, field: T)

Sets inclusion with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_inclusion<T: Into<OcsInclusionProof>>(self, field: T) -> Self

Sets inclusion with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn non_inclusion(&self) -> &OcsNonInclusionProof

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

pub fn non_inclusion_opt(&self) -> Option<&OcsNonInclusionProof>

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

pub fn non_inclusion_opt_mut(&mut self) -> Option<&mut OcsNonInclusionProof>

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

pub fn non_inclusion_mut(&mut self) -> &mut OcsNonInclusionProof

Returns a mutable reference to non_inclusion. If the field is unset, it is first initialized with the default value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn set_non_inclusion<T: Into<OcsNonInclusionProof>>(&mut self, field: T)

Sets non_inclusion with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

pub fn with_non_inclusion<T: Into<OcsNonInclusionProof>>(self, field: T) -> Self

Sets non_inclusion with the provided value. If any other oneof field in the same oneof is set, it will be cleared.

impl GetCheckpointObjectProofResponse

pub fn checkpoint_summary(&self) -> &[u8]

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

Trait Implementations

impl Clone for GetCheckpointObjectProofResponse

fn clone(&self) -> GetCheckpointObjectProofResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetCheckpointObjectProofResponse

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

Formats the value using the given formatter.

impl Default for GetCheckpointObjectProofResponse

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetCheckpointObjectProofResponse

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for GetCheckpointObjectProofResponse

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 GetCheckpointObjectProofResponse

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

impl PartialEq for GetCheckpointObjectProofResponse

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

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 GetCheckpointObjectProofResponse