Struct BoundedNote 

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

A length-bounded note string (max 200 chars / 512 bytes).

Used for note (personal) and payer_note (payer-provided) fields on payments. Construction validates that the string is within limits; deserialization rejects strings that exceed either limit.

For untrusted external input that should be silently truncated rather than rejected, use BoundedNote::truncate.

Implementations

impl BoundedNote

pub fn new(s: String) -> Result<BoundedNote, NoteTooLong>

Constructs a note, returning NoteTooLong if it’s empty or invalid.

pub fn truncate(s: String) -> Option<BoundedNote>

Silently truncate a string to fit within note limits.

Truncates by character count first, then by byte count. Returns None if the result is empty after truncation.

Use this for untrusted external input (e.g. inbound LNURL comments, BOLT12 payer notes) where rejecting would cause payment failures.

pub fn inner(&self) -> &str

Returns the note as a string slice.

pub fn into_inner(self) -> String

Consumes the note and returns the inner string.

Trait Implementations

impl Clone for BoundedNote

fn clone(&self) -> BoundedNote

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoundedNote

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BoundedNote

fn deserialize<D>( deserializer: D, ) -> Result<BoundedNote, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BoundedNote

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

Formats the value using the given formatter.

impl FromStr for BoundedNote

type Err = NoteTooLong

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<BoundedNote, <BoundedNote as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for BoundedNote

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BoundedNote

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for BoundedNote

type Error = NoteTooLong

The type returned in the event of a conversion error.

fn try_from( s: String, ) -> Result<BoundedNote, <BoundedNote as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for BoundedNote

impl StructuralPartialEq for BoundedNote