Struct OcsInclusionProof 

#[non_exhaustive]
pub struct OcsInclusionProof {
    pub object_ref: Option<ObjectReference>,
    pub merkle_proof: Option<MerkleProof>,
    pub leaf_index: Option<u64>,
    pub tree_root: Option<Bytes>,
    pub object_data: Option<Bytes>,
}

Available on crate feature unstable only.

An Object Checkpoint State (OCS) inclusion proof.

The OCS is a Blake2b256 Merkle tree built by each checkpoint over the set of object references it modified (created, mutated, unwrapped, or otherwise written). Each leaf is a BCS-encoded (ObjectID, SequenceNumber, ObjectDigest) tuple, with leaves arranged in ascending ObjectID order. The tree’s root is committed to by the containing CheckpointSummary via the CheckpointArtifacts variant of its checkpoint_commitments.

An OcsInclusionProof proves that a particular leaf appears in this tree. Combined with a verified CheckpointSummary it cryptographically authenticates that a specific object reference was written in a specific checkpoint.

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.

object_ref: Option<ObjectReference>

Object reference being proven: (object_id, version, digest). For a deletion or wrap, digest is a framework sentinel value and object_data is absent. Consumers that only care whether the object is live after the change can check object_data presence instead of inspecting the digest.

merkle_proof: Option<MerkleProof>

Merkle inclusion proof for the leaf.

leaf_index: Option<u64>

Position of the leaf in the modified-objects tree.

tree_root: Option<Bytes>

32-byte Merkle root of the modified-objects tree.

object_data: Option<Bytes>

BCS-encoded Object data at the version committed by this checkpoint. Present iff the modification left the object live (created, mutated, or unwrapped). Absent if the modification was a deletion or wrap.

Implementations

impl OcsInclusionProof

pub const OBJECT_REF_FIELD: &'static MessageField

pub const MERKLE_PROOF_FIELD: &'static MessageField

pub const LEAF_INDEX_FIELD: &'static MessageField

pub const TREE_ROOT_FIELD: &'static MessageField

pub const OBJECT_DATA_FIELD: &'static MessageField

impl OcsInclusionProof

pub fn path_builder() -> OcsInclusionProofFieldPathBuilder

impl OcsInclusionProof

pub const fn const_default() -> Self

pub fn object_ref(&self) -> &ObjectReference

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

pub fn object_ref_opt_mut(&mut self) -> Option<&mut ObjectReference>

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

pub fn object_ref_mut(&mut self) -> &mut ObjectReference

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

pub fn object_ref_opt(&self) -> Option<&ObjectReference>

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

pub fn set_object_ref<T: Into<ObjectReference>>(&mut self, field: T)

Sets object_ref with the provided value.

pub fn with_object_ref<T: Into<ObjectReference>>(self, field: T) -> Self

Sets object_ref with the provided value.

pub fn merkle_proof(&self) -> &MerkleProof

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

pub fn merkle_proof_opt_mut(&mut self) -> Option<&mut MerkleProof>

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

pub fn merkle_proof_mut(&mut self) -> &mut MerkleProof

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

pub fn merkle_proof_opt(&self) -> Option<&MerkleProof>

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

pub fn set_merkle_proof<T: Into<MerkleProof>>(&mut self, field: T)

Sets merkle_proof with the provided value.

pub fn with_merkle_proof<T: Into<MerkleProof>>(self, field: T) -> Self

Sets merkle_proof with the provided value.

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

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

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

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

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

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

pub fn set_leaf_index(&mut self, field: u64)

Sets leaf_index with the provided value.

pub fn with_leaf_index(self, field: u64) -> Self

Sets leaf_index with the provided value.

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

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

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

Sets tree_root with the provided value.

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

Sets tree_root with the provided value.

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

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

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

Sets object_data with the provided value.

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

Sets object_data with the provided value.

impl OcsInclusionProof

pub fn leaf_index(&self) -> u64

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

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

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

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

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

Trait Implementations

impl Clone for OcsInclusionProof

fn clone(&self) -> OcsInclusionProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OcsInclusionProof

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

Formats the value using the given formatter.

impl Default for OcsInclusionProof

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OcsInclusionProof

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OcsInclusionProof> for OcsInclusionProof

fn from(value: &SdkOcsInclusionProof) -> Self

Converts to this type from the input type.

impl From<OcsInclusionProof> for OcsInclusionProof

fn from(value: SdkOcsInclusionProof) -> Self

Converts to this type from the input type.

impl Message for OcsInclusionProof

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 OcsInclusionProof

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

impl PartialEq for OcsInclusionProof

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&OcsInclusionProof> for OcsInclusionProof

type Error = TryFromProtoError

The type returned in the event of a conversion error.

fn try_from(value: &OcsInclusionProof) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for OcsInclusionProof