Struct PrivateNoteHeader 

pub struct PrivateNoteHeader(/* private fields */);

A NoteHeader of a private note.

Implementations

impl PrivateNoteHeader

pub fn new(header: NoteHeader) -> Result<Self, OutputNoteError>

Creates a new PrivateNoteHeader from the given note header.

Errors

Returns an error if:

• The provided header is for a public note.

pub fn id(&self) -> NoteId

Returns the note’s identifier.

The NoteId value is both an unique identifier and a commitment to the note.

pub fn metadata(&self) -> &NoteMetadata

Returns the note’s metadata.

pub fn into_metadata(self) -> NoteMetadata

Consumes self and returns the note header’s metadata.

pub fn commitment(&self) -> Word

Returns a commitment to the note and its metadata.

hash(NOTE_ID || NOTE_METADATA_COMMITMENT)

This value is used primarily for authenticating notes consumed when they are consumed in a transaction.

pub fn as_header(&self) -> &NoteHeader

Returns a reference to the underlying note header.

pub fn into_header(self) -> NoteHeader

Consumes this wrapper and returns the underlying note header.

Trait Implementations

impl Clone for PrivateNoteHeader

fn clone(&self) -> PrivateNoteHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateNoteHeader

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

Formats the value using the given formatter.

impl Deserializable for PrivateNoteHeader

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl PartialEq for PrivateNoteHeader

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for PrivateNoteHeader

impl StructuralPartialEq for PrivateNoteHeader