Struct MerkleNonInclusionProof 

#[non_exhaustive]
pub struct MerkleNonInclusionProof {
    pub index: Option<u64>,
    pub left_leaf: Option<MerkleNeighbourLeaf>,
    pub right_leaf: Option<MerkleNeighbourLeaf>,
}

Available on crate feature unstable only.

A non-inclusion proof for a Blake2b256 Merkle tree built over leaves in sorted order.

The proof carries the absent leaf’s would-be position in sort order plus inclusion proofs for the leaves immediately before and after it. A verifier checks that the two neighbours strictly bracket the target’s sort key and that they sit at adjacent indices in the tree.

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.

index: Option<u64>

The 0-based index the target would occupy in sort order if it were present. left_leaf is unset iff index == 0 (the target would be the very first leaf); right_leaf is unset iff the target would be appended past the last leaf, in which case left_leaf.merkle_proof must identify the tree’s right-most leaf.

left_leaf: Option<MerkleNeighbourLeaf>

Sort-order neighbour with sort key strictly less than the target, accompanied by its inclusion proof at position index - 1.

right_leaf: Option<MerkleNeighbourLeaf>

Sort-order neighbour with sort key strictly greater than the target, accompanied by its inclusion proof at position index.

Implementations

impl MerkleNonInclusionProof

pub const INDEX_FIELD: &'static MessageField

pub const LEFT_LEAF_FIELD: &'static MessageField

pub const RIGHT_LEAF_FIELD: &'static MessageField

impl MerkleNonInclusionProof

pub fn path_builder() -> MerkleNonInclusionProofFieldPathBuilder

impl MerkleNonInclusionProof

pub const fn const_default() -> Self

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

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

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

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

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

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

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

Sets index with the provided value.

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

Sets index with the provided value.

pub fn left_leaf(&self) -> &MerkleNeighbourLeaf

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

pub fn left_leaf_opt_mut(&mut self) -> Option<&mut MerkleNeighbourLeaf>

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

pub fn left_leaf_mut(&mut self) -> &mut MerkleNeighbourLeaf

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

pub fn left_leaf_opt(&self) -> Option<&MerkleNeighbourLeaf>

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

pub fn set_left_leaf<T: Into<MerkleNeighbourLeaf>>(&mut self, field: T)

Sets left_leaf with the provided value.

pub fn with_left_leaf<T: Into<MerkleNeighbourLeaf>>(self, field: T) -> Self

Sets left_leaf with the provided value.

pub fn right_leaf(&self) -> &MerkleNeighbourLeaf

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

pub fn right_leaf_opt_mut(&mut self) -> Option<&mut MerkleNeighbourLeaf>

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

pub fn right_leaf_mut(&mut self) -> &mut MerkleNeighbourLeaf

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

pub fn right_leaf_opt(&self) -> Option<&MerkleNeighbourLeaf>

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

pub fn set_right_leaf<T: Into<MerkleNeighbourLeaf>>(&mut self, field: T)

Sets right_leaf with the provided value.

pub fn with_right_leaf<T: Into<MerkleNeighbourLeaf>>(self, field: T) -> Self

Sets right_leaf with the provided value.

impl MerkleNonInclusionProof

pub fn index(&self) -> u64

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

Trait Implementations

impl Clone for MerkleNonInclusionProof

fn clone(&self) -> MerkleNonInclusionProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleNonInclusionProof

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

Formats the value using the given formatter.

impl Default for MerkleNonInclusionProof

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MerkleNonInclusionProof

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&MerkleNonInclusionProof<ObjectReference>> for MerkleNonInclusionProof

fn from(value: &SdkMerkleNonInclusionProof<ObjectReference>) -> Self

Converts to this type from the input type.

impl From<MerkleNonInclusionProof<ObjectReference>> for MerkleNonInclusionProof

fn from(value: SdkMerkleNonInclusionProof<ObjectReference>) -> Self

Converts to this type from the input type.

impl Message for MerkleNonInclusionProof

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 MerkleNonInclusionProof

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

impl PartialEq for MerkleNonInclusionProof

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MerkleNonInclusionProof> for MerkleNonInclusionProof<ObjectReference>

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for MerkleNonInclusionProof