Struct Cpf

pub struct Cpf(/* private fields */);

A valid CPF number. Parsing recognizes numbers with or without separators (dot, minus, and slash).

Implementations

impl Cpf

pub fn from_slice(slice: &[u8]) -> Result<Self, ParseCpfError>

Parses a byte slice of numbers as an CPF, guessing the missing parts.

Examples

Basic usage:

use brids::Cpf;

match Cpf::from_slice(&[1, 2, 3, 4, 5, 6, 7, 8, 9, 0, 9]) {
    Ok(cpf) => println!("{cpf} is a valid number."),
    Err(err) => eprintln!("Error: {err}"),
}

Guess the check digits:

use brids::Cpf;

match Cpf::from_slice(&[1, 2, 3, 4, 5, 6, 7, 8, 9]) {
    Ok(cpf) => println!("{cpf} is a valid number."),
    Err(err) => eprintln!("Error: {err}"),
}

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

Returns a byte slice of the numbers.

Examples

use brids::Cpf;

let cpf = "123.456.789-09".parse::<Cpf>().expect("Invalid CPF");
let digits = cpf.as_bytes();

pub fn generate() -> Self

Generates a random number, using rand::thread_rng (requires std and rand features). To use a different generator, instantiate the generator directly.

Examples

use brids::Cpf;

let cpf = Cpf::generate();

Trait Implementations

impl AsRef<[u8]> for Cpf

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Cpf

fn clone(&self) -> Cpf

Returns a duplicate 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<'de> Deserialize<'de> for Cpf

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Cpf

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

Formats the value using the given formatter.

impl Distribution<Cpf> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Cpf

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<Cpf> for [u8; 11]

fn from(cpf: Cpf) -> [u8; 11]

Converts to this type from the input type.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Cpf

fn cmp(&self, other: &Cpf) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Cpf

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

fn partial_cmp(&self, other: &Cpf) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Cpf

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for Cpf

type Error = ParseCpfError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> 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 StructuralPartialEq for Cpf