Struct BasketItem 

#[non_exhaustive]
pub struct BasketItem {
    pub id: Box<str>,
    pub name: Box<str>,
    pub category: Option<Box<str>>,
    pub kind: ItemKind,
    pub price: Money,
    pub quantity: u32,
}

One line of what is being paid for.

BasketItem::price is what one of the thing costs, and BasketItem::line_total is what the line comes to. The distinction is not cosmetic: PayTR takes the unit price and the count as two fields, and iyzico takes one figure and has nowhere to put a count, so an adapter that guessed which of the two it had been handed would silently charge a basket of three for one.

The sum of a basket does not have to equal ChargeRequest::amount, and nothing here checks that it does: an instalment surcharge is money the payer is charged and not a line of the basket, which is exactly the difference Charge::order_amount exists for.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

id: Box<str>

The shop’s own id for it.

name: Box<str>

What it is called.

category: Option<Box<str>>

The category it sits in. iyzico asks; nobody else does.

kind: ItemKind

Whether it ships.

price: Money

What one of it costs. BasketItem::line_total is the whole line.

quantity: u32

How many. PayTR sends this as its own field; iyzico has no such field, so its adapter sends the line total instead.

Implementations

impl BasketItem

pub fn new( id: impl Into<Box<str>>, name: impl Into<Box<str>>, price: Money, ) -> BasketItem

One line, priced.

pub fn category(self, category: impl Into<Box<str>>) -> BasketItem

Says which category it sits in.

pub const fn virtual_item(self) -> BasketItem

Marks the line as something that does not ship.

pub const fn quantity(self, quantity: u32) -> BasketItem

Says how many of it.

pub fn line_total(&self) -> Result<Money, MoneyError>

What the line comes to: the unit price times the count.

Trait Implementations

impl Clone for BasketItem

fn clone(&self) -> BasketItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasketItem

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

Formats the value using the given formatter.

impl Eq for BasketItem

impl PartialEq for BasketItem

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BasketItem