Struct MerkleNeighbourLeaf 

#[non_exhaustive]
pub struct MerkleNeighbourLeaf {
    pub leaf: Option<ObjectReference>,
    pub merkle_proof: Option<MerkleProof>,
}

Available on crate feature unstable only.

A neighbour leaf in a MerkleNonInclusionProof: an object reference at a specific sorted position in the OCS tree, plus the inclusion proof that authenticates it against the tree root.

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.

leaf: Option<ObjectReference>

The object reference stored at this leaf.

merkle_proof: Option<MerkleProof>

Inclusion proof for leaf at its position in the tree.

Implementations

impl MerkleNeighbourLeaf

pub const LEAF_FIELD: &'static MessageField

pub const MERKLE_PROOF_FIELD: &'static MessageField

impl MerkleNeighbourLeaf

pub fn path_builder() -> MerkleNeighbourLeafFieldPathBuilder

impl MerkleNeighbourLeaf

pub const fn const_default() -> Self

pub fn leaf(&self) -> &ObjectReference

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

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

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

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

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

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

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

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

Sets leaf with the provided value.

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

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

Trait Implementations

impl Clone for MerkleNeighbourLeaf

fn clone(&self) -> MerkleNeighbourLeaf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MerkleNeighbourLeaf

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

Formats the value using the given formatter.

impl Default for MerkleNeighbourLeaf

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MerkleNeighbourLeaf

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&(ObjectReference, MerkleProof)> for MerkleNeighbourLeaf

fn from(value: &(ObjectReference, MerkleProof)) -> Self

Converts to this type from the input type.

impl Message for MerkleNeighbourLeaf

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 MerkleNeighbourLeaf

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

impl PartialEq for MerkleNeighbourLeaf

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MerkleNeighbourLeaf> for (ObjectReference, MerkleProof)

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for MerkleNeighbourLeaf