Struct PaymentEndpointIdentifier 

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

Machine-readable identifier for a Payment Endpoint.

A PaymentEndpointIdentifier is a single, safe path segment stored in an app-owned endpoint directory. It is validated at construction time to prevent path injection attacks.

Allowed characters

ASCII alphanumeric (a-z, A-Z, 0-9), hyphens (-), underscores (_), and dots (.) — but the value must not consist solely of dots (i.e. "." and ".." are rejected).

Limits

• Must not be empty.
• Must not exceed 64 characters.
• Must not be a reserved Paykit storage value.

Examples

let id = PaymentEndpointIdentifier::new("btc-lightning-bolt11").unwrap();
assert_eq!(id.as_str(), "btc-lightning-bolt11");

// Path traversal is rejected:
assert!(PaymentEndpointIdentifier::new("../etc/passwd").is_err());

Implementations

impl PaymentEndpointIdentifier

pub fn new(id: impl Into<String>) -> Result<Self>

Create a new PaymentEndpointIdentifier after validating the identifier.

Returns Err(PaykitError::Validation) if the value is empty, too long, contains forbidden characters, resembles a path-traversal component, or collides with a reserved identifier.

pub fn as_str(&self) -> &str

Access the inner identifier string.

Trait Implementations

impl AsRef<str> for PaymentEndpointIdentifier

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PaymentEndpointIdentifier

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentEndpointIdentifier

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

Formats the value using the given formatter.

impl Display for PaymentEndpointIdentifier

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

Formats the value using the given formatter.

impl Eq for PaymentEndpointIdentifier

impl Hash for PaymentEndpointIdentifier

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

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 PaymentEndpointIdentifier

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PaymentEndpointIdentifier