Struct iban::BaseIban

pub struct BaseIban { /* fields omitted */ }

Represents an IBAN that passed basic checks, but not necessarily the BBAN validation. This corresponds to the validation as described in ISO 13616-1.

To be exact, the IBAN must start with two uppercase ASCII letters, followed by two digits, followed by any number of digits and ASCII letters. Additionally its checksum should be valid. It should either contain no whitespace, or be in the paper format, where characters are in space-separated groups of four.

Note that most useful methods are supplied by the trait IbanLike. The Display trait provides pretty print formatting.

Examples

An example of parsing and using a correct IBAN:

use iban::{BaseIban, IbanLike};

let iban: BaseIban = "MR13 0002 0001 0100 0012 3456 753".parse()?;
assert_eq!(iban.electronic_str(), "MR1300020001010000123456753");
// The pretty print format
assert_eq!(iban.to_string(), "MR13 0002 0001 0100 0012 3456 753");
assert_eq!(iban.country_code(), "MR");
assert_eq!(iban.check_digits_str(), "13");
assert_eq!(iban.check_digits(), 13);
assert_eq!(iban.bban_unchecked(), "00020001010000123456753");

An example of parsing invalid IBANs:

use iban::{BaseIban, ParseBaseIbanError};

assert_eq!(
    "MR$$".parse::<BaseIban>(),
    Err(ParseBaseIbanError::InvalidFormat)
);

assert_eq!(
    "MR0000020001010000123456754".parse::<BaseIban>(),
    Err(ParseBaseIbanError::InvalidChecksum)
);

Trait Implementations

impl Clone for BaseIban

fn clone(&self) -> BaseIban

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BaseIban

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

Formats the value using the given formatter.

impl Display for BaseIban

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

Formats the value using the given formatter.

impl From<Iban> for BaseIban

fn from(value: Iban) -> BaseIban

Performs the conversion.

impl FromStr for BaseIban

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

Parse a basic iban without taking the BBAN into consideration.

Errors

If the string does not match the IBAN format or the checksum is invalid, an ParseBaseIbanError will be returned.

type Err = ParseBaseIbanError

The associated error which can be returned from parsing.

impl Hash for BaseIban

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, 

Feeds a slice of this type into the given Hasher.

impl IbanLike for BaseIban

fn electronic_str(&self) -> &str

Get the IBAN in the electronic format, without whitespace. This method is simply a view into the inner string.

fn country_code(&self) -> &str

Get the country code of the IBAN. This method simply returns a slice of the inner representation.

fn check_digits_str(&self) -> &str

Get the check digits of the IBAN, as a string slice. This method simply returns a slice of the inner representation. To obtain an integer instead, use check_digits.

fn check_digits(&self) -> u8

Get the check digits of the IBAN. This method parses the digits to an integer, performing slightly more work than check_digits_str.

fn bban_unchecked(&self) -> &str

Get the BBAN part of the IBAN, as a &str. Note that the BBAN is not necessarily valid if this is not guaranteed by the implementing type. Use Iban::bban to guarantee a correct BBAN.

impl PartialEq<BaseIban> for BaseIban

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

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

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

This method tests for !=.

impl<'a> TryFrom<&'a str> for BaseIban

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Parse a basic IBAN without taking the BBAN into consideration.

Errors

If the string does not match the IBAN format or the checksum is invalid, an ParseBaseIbanError will be returned.

type Error = ParseBaseIbanError

The type returned in the event of a conversion error.

impl TryFrom<BaseIban> for Iban

fn try_from(base_iban: BaseIban) -> Result<Iban, ParseIbanError>

Parse an IBAN without taking the BBAN into consideration.

Errors

If the string does not match the IBAN format or the checksum is invalid, ParseIbanError::InvalidBaseIban will be returned. If the country format is invalid or unknown, the other variants will be returned with the BaseIban giving access to some basic functionality nonetheless.

type Error = ParseIbanError

The type returned in the event of a conversion error.

impl Copy for BaseIban

impl Eq for BaseIban

impl StructuralEq for BaseIban

impl StructuralPartialEq for BaseIban