Struct Invoice 

pub struct Invoice { /* private fields */ }

A general invoice with same-currency line totals.

Implementations

impl Invoice

pub fn from_lines( number: InvoiceNumber, lines: Vec<InvoiceLine>, ) -> Result<Self, InvoiceError>

Creates an open invoice from same-currency lines.

Errors

Returns InvoiceError::NoLines when no lines are supplied and InvoiceError::Money when line totals cannot be added.

pub fn new( number: InvoiceNumber, status: InvoiceStatus, due_date: Option<DueDate>, lines: Vec<InvoiceLine>, ) -> Result<Self, InvoiceError>

Creates an invoice from same-currency lines.

Errors

Returns InvoiceError::NoLines when no lines are supplied and InvoiceError::Money when line totals cannot be added.

pub fn with_due_date(self, due_date: DueDate) -> Self

Returns a copy of this invoice with a due date.

pub fn with_amount_paid(self, amount_paid: &Money) -> Result<Self, InvoiceError>

Returns a copy of this invoice with an amount paid applied to the balance due.

Errors

Returns InvoiceError::Money when the payment currency or amount scale is incompatible.

pub const fn number(&self) -> &InvoiceNumber

Returns the invoice number.

pub const fn status(&self) -> InvoiceStatus

Returns the invoice status.

pub const fn due_date(&self) -> Option<&DueDate>

Returns the optional due date.

pub fn lines(&self) -> &[InvoiceLine]

Returns the invoice lines.

pub fn iter(&self) -> Iter<'_, InvoiceLine>

Iterates over invoice lines.

pub const fn subtotal(&self) -> &Subtotal

Returns the subtotal.

pub const fn total(&self) -> &Total

Returns the total.

pub const fn balance_due(&self) -> &BalanceDue

Returns the balance due.

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Invoice

type Item = &'a InvoiceLine

The type of the elements being iterated over.

type IntoIter = Iter<'a, InvoiceLine>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Invoice

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

impl StructuralPartialEq for Invoice