Struct Note 

pub struct Note { /* private fields */ }

A Note is a text and signatures.

Implementations

impl Note

pub fn new(text: &[u8], existing_sigs: &[Signature]) -> Result<Self, NoteError>

Returns a new note, ensuring that the text is well-formed, and appending the provided signatures.

Errors

Returns a NoteError::MalformedNote if the text is larger than we’re willing to parse, cannot be decoded as UTF-8, or contains any non-newline ASCII control characters.

pub fn from_bytes(msg: &[u8]) -> Result<Self, NoteError>

Parses the message msg into a note, returning a NoteError if any of the text or signatures are malformed.

Errors

Returns a NoteError::MalformedNote if the message is larger than we’re willing to parse, cannot be decoded as UTF-8, contains any non-newline ASCII control characters, or is otherwise invalid.

pub fn verify( &self, known: &impl Verifiers, ) -> Result<(Vec<Signature>, Vec<Signature>), NoteError>

Checks signatures on the note for those from known verifiers.

For each signature in the message, Note::verify calls known.verifier to find a verifier. If known.verifier returns a verifier and the verifier accepts the signature, Note::verify includes the signature in the returned list of verified signatures. If known.verifier returns a VerificationError::UnknownKey, Note::verify includes the signature in the returned list of unverified signatures.

Errors

If known.verifier returns a verifier but the verifier rejects the signature, Note::verify returns a NoteError::InvalidSignature. If known.verifier returns any other error, Note::verify returns that error.

If no known verifier has signed an otherwise valid note, Note::verify returns an NoteError::UnverifiedNote.

pub fn add_sigs(&mut self, signers: &[&dyn Signer]) -> Result<(), NoteError>

Signs the note with the given signers. The new signatures from signers are listed in the encoded message after the existing signatures already present in n.sigs. If any signer uses the same key as an existing signature, the existing signature is removed.

Errors

Returns an error if any signers have invalid names. Names must be non-empty and not have any Unicode spaces or pluses.

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

Returns a well-formed signed note.

pub fn text(&self) -> &[u8]

Returns the note’s text.

Trait Implementations

impl Debug for Note

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

Formats the value using the given formatter.

impl PartialEq for Note

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