Struct OcsNonInclusionProof 

#[non_exhaustive]
pub struct OcsNonInclusionProof {
    pub non_inclusion_proof: Option<MerkleNonInclusionProof>,
    pub tree_root: Option<Bytes>,
}

Available on crate feature unstable only.

An Object Checkpoint State (OCS) non-inclusion proof.

Proves that no leaf with a given object id appears in the OCS Merkle tree – i.e. that the checkpoint did not modify the object id at all. The proof’s bracketing neighbours must have object ids strictly flanking the target id, which combined with the neighbours being at adjacent indices in the sorted tree proves that no leaf with any version or digest under the target id can be in the tree.

As with OcsInclusionProof, this is anchored at the containing CheckpointSummary’s CheckpointArtifacts commitment.

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.

non_inclusion_proof: Option<MerkleNonInclusionProof>

Merkle non-inclusion proof over the OCS tree.

tree_root: Option<Bytes>

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

Implementations

impl OcsNonInclusionProof

pub const NON_INCLUSION_PROOF_FIELD: &'static MessageField

pub const TREE_ROOT_FIELD: &'static MessageField

impl OcsNonInclusionProof

pub fn path_builder() -> OcsNonInclusionProofFieldPathBuilder

impl OcsNonInclusionProof

pub const fn const_default() -> Self

pub fn non_inclusion_proof(&self) -> &MerkleNonInclusionProof

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

pub fn non_inclusion_proof_opt_mut( &mut self, ) -> Option<&mut MerkleNonInclusionProof>

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

pub fn non_inclusion_proof_mut(&mut self) -> &mut MerkleNonInclusionProof

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

pub fn non_inclusion_proof_opt(&self) -> Option<&MerkleNonInclusionProof>

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

pub fn set_non_inclusion_proof<T: Into<MerkleNonInclusionProof>>( &mut self, field: T, )

Sets non_inclusion_proof with the provided value.

pub fn with_non_inclusion_proof<T: Into<MerkleNonInclusionProof>>( self, field: T, ) -> Self

Sets non_inclusion_proof 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.

impl OcsNonInclusionProof

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

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

Trait Implementations

impl Clone for OcsNonInclusionProof

fn clone(&self) -> OcsNonInclusionProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OcsNonInclusionProof

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

Formats the value using the given formatter.

impl Default for OcsNonInclusionProof

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OcsNonInclusionProof

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OcsNonInclusionProof> for OcsNonInclusionProof

fn from(value: &SdkOcsNonInclusionProof) -> Self

Converts to this type from the input type.

impl From<OcsNonInclusionProof> for OcsNonInclusionProof

fn from(value: SdkOcsNonInclusionProof) -> Self

Converts to this type from the input type.

impl Message for OcsNonInclusionProof

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 OcsNonInclusionProof

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

impl PartialEq for OcsNonInclusionProof

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&OcsNonInclusionProof> for OcsNonInclusionProof

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for OcsNonInclusionProof