Struct NoteHeader

pub struct NoteHeader { /* private fields */ }

Holds the strictly required, public information of a note.

See NoteId and NoteMetadata for additional details.

Implementations

impl NoteHeader

pub fn new(note_id: NoteId, note_metadata: NoteMetadata) -> Self

Returns a new NoteHeader instantiated from the specified note ID and metadata.

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 commitment(&self) -> Digest

Returns a commitment to the note and its metadata.

hash(NOTE_ID || NOTE_METADATA)

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

Trait Implementations

impl Clone for NoteHeader

fn clone(&self) -> NoteHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteHeader

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

Formats the value using the given formatter.

impl Deserializable for NoteHeader

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 read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

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

impl From<&Note> for NoteHeader

fn from(note: &Note) -> Self

Converts to this type from the input type.

impl From<&NoteHeader> for [Word; 2]

fn from(note_header: &NoteHeader) -> Self

Converts to this type from the input type.

impl From<&NoteHeader> for [Felt; 8]

fn from(note_header: &NoteHeader) -> Self

Converts to this type from the input type.

impl From<&NoteHeader> for [u8; 64]

fn from(note_header: &NoteHeader) -> Self

Converts to this type from the input type.

impl From<&OutputNote> for NoteHeader

fn from(value: &OutputNote) -> Self

Converts to this type from the input type.

impl From<&PartialNote> for NoteHeader

fn from(note: &PartialNote) -> Self

Converts to this type from the input type.

impl From<Note> for NoteHeader

fn from(note: Note) -> Self

Converts to this type from the input type.

impl From<NoteHeader> for [Word; 2]

fn from(note_header: NoteHeader) -> Self

Converts to this type from the input type.

impl From<NoteHeader> for [Felt; 8]

fn from(note_header: NoteHeader) -> Self

Converts to this type from the input type.

impl From<NoteHeader> for [u8; 64]

fn from(note_header: NoteHeader) -> Self

Converts to this type from the input type.

impl From<OutputNote> for NoteHeader

fn from(value: OutputNote) -> Self

Converts to this type from the input type.

impl From<PartialNote> for NoteHeader

fn from(note: PartialNote) -> Self

Converts to this type from the input type.

impl PartialEq for NoteHeader

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

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

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

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

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

impl Copy for NoteHeader

impl Eq for NoteHeader

impl StructuralPartialEq for NoteHeader