Struct Id 

pub struct Id<K: IdKind> { /* private fields */ }

How a provider names one thing of kind K.

Opaque on purpose: Stripe issues pi_…, iyzico a 64-bit integer, PayTR nothing at all, and nothing outside the adapter should read any of them. Display writes the text alone, because that is what goes into a request.

Two facts travel with the text. K is what the identifier names, and it is checked by the compiler: a PaymentId cannot be passed where the token of a hosted checkout form is wanted, however alike the two strings look. Id::source is whose uniqueness it rests on — the provider’s, or kasapay’s own composition of fields the caller sent.

use kasapay_core::{Id, IdKind, PaymentId};

struct Session;
impl IdKind for Session {
    const NAMES: &'static str = "session";
}

fn refund(payment: &PaymentId) {
    println!("{payment}");
}

// A session is not a payment, and this does not compile.
refund(&Id::<Session>::issued("tok-1"));

Implementations

impl<K: IdKind> Id<K>

pub fn issued(value: impl Into<Box<str>>) -> Self

Wraps an identifier the provider issued.

pub fn derived( value: impl Into<Box<str>>, from: &'static [&'static str], ) -> Self

Wraps an identifier kasapay composed, naming the fields it came from.

For a provider that issues none of its own: PayTR names a payment by the merchant_oid the merchant chose and sent. from is what the value’s uniqueness actually rests on, and a caller reads it back through Id::source.

pub fn as_str(&self) -> &str

The identifier as text.

pub const fn source(&self) -> IdSource

Whose uniqueness this identifier rests on.

Trait Implementations

impl<K: IdKind> Clone for Id<K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: IdKind> Debug for Id<K>

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

Formats the value using the given formatter.

impl<K: IdKind> Display for Id<K>

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

Formats the value using the given formatter.

impl<K: IdKind> Eq for Id<K>

impl<K: IdKind> Hash for Id<K>

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<K: IdKind> Ord for Id<K>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<K: IdKind> PartialEq for Id<K>

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

Equality operator ==.

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

Inequality operator !=.

impl<K: IdKind> PartialOrd for Id<K>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.