Struct cpf::Cpf

pub struct Cpf { /* fields omitted */ }

A valid CPF number.

Initialize a Cpf from a &str or an array of digits:

use cpf::Cpf;

let cpf1 = "385.211.390-39".parse::<Cpf>()?;
let cpf2 = Cpf::try_from([3, 8, 5, 2, 1, 1, 3, 9, 0, 3, 9])?;
assert_eq!(cpf1, cpf2);

Note that the Cpf struct can only be initialized after a successfully parse, so it is guaranteed to always be valid.

use cpf::Cpf;

let cpf = "000.000.000-00".parse::<Cpf>();
assert!(cpf.is_err());

let cpf = "385.211.390-39".parse::<Cpf>().unwrap();
assert!(cpf::valid(cpf));

Implementations

impl Cpf

pub fn digits(&self) -> [u8; 11]

The Cpf digits.

use cpf::Cpf;

let cpf: Cpf = "385.211.390-39".parse()?;
assert_eq!(cpf.digits(), [3, 8, 5, 2, 1, 1, 3, 9, 0, 3, 9]);

pub fn as_str(&self) -> &str

Returns the (unformatted) CPF number.

use cpf::Cpf;

let cpf: Cpf = "385.211.390-39".parse()?;
assert_eq!(cpf.as_str(), "38521139039");

Note that even being unformatted, the number will be padded by zeros.

use cpf::Cpf;

let cpf: Cpf = "5120101".parse()?;
assert_eq!(cpf.as_str(), "00005120101");

Trait Implementations

impl AsRef<str> for Cpf

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for Cpf

fn clone(&self) -> Cpf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cpf

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

Formats the value using the given formatter.

impl Display for Cpf

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

Formats the value using the given formatter.

impl FromStr for Cpf

type Err = ParseCpfError

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 Hash for Cpf

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 PartialEq<Cpf> for Cpf

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

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

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

This method tests for !=.

impl TryFrom<&'_ str> for Cpf

type Error = ParseCpfError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 11]> for Cpf

type Error = ParseCpfError

The type returned in the event of a conversion error.

fn try_from(value: [u8; 11]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Cpf

impl Eq for Cpf

impl StructuralEq for Cpf

impl StructuralPartialEq for Cpf