Struct spayd::Spayd

pub struct Spayd { /* private fields */ }

A Short Payment Descriptor structure containint the details of a requested payment.

Implementations

impl Spayd

pub fn account(&self) -> Result<IbanBic, SpaydError>

Get the account number as a separated IBAN and BIC

pub fn set_account<T>(&mut self, account: T)

where T: Into<IbanBic>,

Set the account IBAN from an IBAN and BIC

pub fn alternative_accounts(&self) -> Result<Vec<IbanBic>, SpaydError>

Get alternative account numbers

pub fn set_alternative_accounts<I, T>(&mut self, accounts: I)

where I: IntoIterator<Item = T>, T: Into<IbanBic>,

Set alternative account numbers

pub fn due_date(&self) -> Result<NaiveDate, SpaydError>

Get the due date as a Chrono NaiveDate

pub fn set_due_date(&mut self, date: &NaiveDate)

Set the due date from a Chrono NaiveDate

pub fn amount(&self) -> Result<Decimal, SpaydError>

Get the payment amount as a decimal

pub fn set_amount(&mut self, amount: &Decimal)

Set the due date from a decimal

pub fn currency(&self) -> Result<Currency, SpaydError>

Get the currency as an ISO currency

pub fn set_currency(&mut self, currency: Currency)

Set the currency using an ISO currency

impl Spayd

pub fn check_crc32(&self) -> Crc32Result

Perform a CRC32 integrity check on the SPAYD to help ensure that it was received correctly. This check does not provide any assurance of the authenticity of the SPAYD value or any other form of cryptographic security.

As the CRC32 field is optional, this will report success when the field is not supplied. To enforce the usage of CRC32 use require_crc32.

pub fn require_crc32(&self) -> Crc32Result

Ensure that a CRC32 checksum is present and check that the SPAYD matches it.

impl<'a> Spayd

pub fn new<I, K, V>(version: SpaydVersion, fields: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: ToString, V: ToString,

Create a new SPAYD with the given version number and field values. Using new_v1_0 or empty_v1_0 is preferable for most situations.

pub fn new_v1_0<I, K, V>(fields: I) -> Self

where I: IntoIterator<Item = (K, V)>, K: ToString, V: ToString,

Create a version 1.0 SPAYD with the given field values.

pub fn empty_v1_0() -> Self

Create an empty version 1.0 SPAYD.

pub fn version(&self) -> SpaydVersion

Get the version number.

pub fn field(&self, key: &str) -> Option<&str>

Get the value of the given field.

pub fn set_field<K, V>(&mut self, key: K, value: V)

where K: ToString, V: ToString,

Set the value of the given field.

pub fn validate(&self) -> Result<(), SpaydError>

Ensure that the SPAYD has all required fields and that the CRC check is correct (if this feature is enabled).

pub fn iter(&self) -> impl Iterator<Item = (&str, &str)>

Iterates over the fields in the SPAYD. No particular ordering is guaranteed.

pub fn iter_canonic(&self) -> impl Iterator<Item = (&str, &str)>

Iterates over the fields in canonic order. The keys are alphabetical and the CRC32 field is excluded. This can be used to create a cannonical represenataion of the SPAYD which can be CRC32 checked.

pub fn canonic_representation(&self) -> String

Construct canonic representation for CRC32 checking

Trait Implementations

impl Clone for Spayd

fn clone(&self) -> Spayd

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spayd

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

Formats the value using the given formatter.

impl Display for Spayd

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

Formats the value using the given formatter.

impl FromStr for Spayd

type Err = SpaydError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl PartialEq for Spayd

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Spayd

impl StructuralEq for Spayd

impl StructuralPartialEq for Spayd