Struct Iban 

pub struct Iban { /* private fields */ }

Represents an IBAN. To obtain it, make use of the parse() function, which will make sure the string follows the ISO 13616 standard. Apart from its own methods, Iban implements IbanLike, which provides more functionality.

The impementation of Display provides spaced formatting of the IBAN. Electronic formatting can be obtained via electronic_str.

A valid IBAN…

• must start with two uppercase ASCII letters, followed by two digits, followed by any number of digits and ASCII letters.
• must have a valid checksum.
• must contain no whitespace, or be in the paper format, where characters are in space-separated groups of four.
• must adhere to the country-specific format.

Sometimes it may be desirable to accept IBANs that do not have their country registered in the IBAN registry, or it may simply be unimportant whether the country’s BBAN format was followed. In that case, you can use a BaseIban instead.

Examples

use iban::*;
let address = "KZ86125KZT5004100100".parse::<iban::Iban>()?;
assert_eq!(address.to_string(), "KZ86 125K ZT50 0410 0100");

Formatting

The IBAN specification describes two formats: an electronic format without whitespace and a paper format which seperates the IBAN in groups of four characters. Both will be parsed correctly by this crate. When formatting, Debug can be used to output the former and Display for the latter. This is true for a BaseIban as well as an Iban. Alternatively, you can use IbanLike::electronic_str to obtain the electronic format as a string slice.

let iban: iban::Iban = "RO66BACX0000001234567890".parse()?;
// Use Debug for the electronic format.
assert_eq!(&format!("{:?}", iban), "RO66BACX0000001234567890");
// Use Display for the pretty print format.
assert_eq!(&format!("{}", iban), "RO66 BACX 0000 0012 3456 7890");

Implementations

impl Iban

pub fn bban(&self) -> &str

Get the BBAN part of the IBAN, as a &str. This method, in contrast to IbanLike::bban_unchecked, is only available on the Iban structure, which means the returned BBAN string is always correct.

Example

use iban::*;
let iban: Iban = "DE44 5001 0517 5407 3249 31".parse()?;
assert_eq!(iban.bban(), "500105175407324931");

pub fn bank_identifier(&self) -> Option<&str>

Get the bank identifier of the IBAN. The bank identifier might not be defined, in which case this method returns None.

Example

use iban::*;
let iban: Iban = "AD12 0001 2030 2003 5910 0100".parse()?;
assert_eq!(iban.bank_identifier(), Some("0001"));

pub fn branch_identifier(&self) -> Option<&str>

Get the branch identifier of the IBAN. The branch identifier might not be defined, in which case this method returns None.

Example

use iban::*;
let iban: Iban = "AD12 0001 2030 2003 5910 0100".parse()?;
assert_eq!(iban.branch_identifier(), Some("2030"));

Trait Implementations

impl Clone for Iban

fn clone(&self) -> Iban

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Iban

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

Formats the value using the given formatter.

impl Display for Iban

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

Formats the value using the given formatter.

impl From<Iban> for BaseIban

fn from(value: Iban) -> BaseIban

Converts to this type from the input type.

impl FromStr for Iban

type Err = ParseIbanError

The associated error which can be returned from parsing.

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

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

impl Hash for Iban

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 IbanLike for Iban

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 for Iban

fn eq(&self, other: &Iban) -> 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<'a> TryFrom<&'a str> for Iban

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

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 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 Iban

impl Eq for Iban

impl StructuralPartialEq for Iban