Enum NoteFile

pub enum NoteFile {
    NoteId(NoteId),
    NoteDetails {
        details: NoteDetails,
        after_block_num: BlockNumber,
        tag: Option<NoteTag>,
    },
    NoteWithProof(Note, NoteInclusionProof),
}

A serialized representation of a note.

Variants

NoteId(NoteId)

The note’s details aren’t known.

NoteDetails

The note may or may not have already been recorded on chain.

The after_block_num specifies the block after which the note is expected to appear on chain. Though this should be treated as a hint (i.e., there is no guarantee that the note will appear on chain or that it will in fact appear after the specified block).

An optional tag specifies the tag associated with the note, though this also should be treated as a hint.

Fields

details: NoteDetails

after_block_num: BlockNumber

tag: Option<NoteTag>

NoteWithProof(Note, NoteInclusionProof)

The note has been recorded on chain.

Implementations

impl NoteFile

pub fn write(&self, filepath: impl AsRef<Path>) -> Result<()>

Serializes and writes binary NoteFile to specified file

pub fn read(filepath: impl AsRef<Path>) -> Result<Self>

Reads from file and tries to deserialize an NoteFile

Trait Implementations

impl Deserializable for NoteFile

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<NoteDetails> for NoteFile

fn from(details: NoteDetails) -> Self

Converts to this type from the input type.

impl From<NoteId> for NoteFile

fn from(note_id: NoteId) -> Self

Converts to this type from the input type.

impl Serializable for NoteFile

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.