Struct BoundedString 

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

A length-bounded 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 BoundedString::truncate.

Implementations

impl BoundedString

pub const MAX_CHARS: usize = 200

Max characters allowed.

pub const MAX_BYTES: usize = 512

Max bytes allowed.

pub fn new(s: String) -> Result<BoundedString, StringTooLong>

Constructs a bounded string, returning StringTooLong if it’s empty or exceeds limits.

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

Silently truncate a string to fit within 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 string as a string slice.

pub fn into_inner(self) -> String

Consumes and returns the inner string.

Trait Implementations

impl Clone for BoundedString

fn clone(&self) -> BoundedString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoundedString

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BoundedString

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BoundedString

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

Formats the value using the given formatter.

impl FromStr for BoundedString

type Err = StringTooLong

The associated error which can be returned from parsing.

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

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

impl Hash for BoundedString

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 BoundedString

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

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 BoundedString

type Error = StringTooLong

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for BoundedString

impl StructuralPartialEq for BoundedString