Struct SIN

pub struct SIN { /* private fields */ }

A social insurance number.

Implementations

impl SIN

pub fn parse(s: String) -> Result<Self, SINParseError>

Parses a SIN from a string.

Examples

use canada_sin::SIN;
assert!(SIN::parse("046454286".to_string()).is_ok());

pub fn types(&self) -> Vec<SINType>

All types the SIN could be. This will often be multiple options, since this is based on the first digit, and we are running out of numbers, so there is some overlap. However, the following can be determined unambiguously:

• CRAAssigned (starts with 0)
• TemporaryResident (starts with 9)
• Quebec (starts with 2 or 3)
• BusinessNumber sometimes (if it starts with 8 it’s a business number, if it starts with 7 it might be one)

The logic is based on this mapping.

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

Returns the parsed digits as an array of digits.

pub fn digits_string(self) -> String

Returns the SIN as a string.

Examples

use canada_sin::SIN;
let sin = SIN::parse("046454286".to_string()).unwrap();
assert_eq!(sin.digits_string(), "046454286")

pub fn digits_dashed_string(self) -> String

Returns the SIN as a string with dashes in it.

Examples

use canada_sin::SIN;
let sin = SIN::parse("046454286".to_string()).unwrap();
assert_eq!(sin.digits_dashed_string(), "046-454-286")

Trait Implementations

impl Clone for SIN

fn clone(&self) -> SIN

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SIN

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

Formats the value using the given formatter.

impl Display for SIN

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

Formats the SIN into three parts with dashes.

Examples

use canada_sin::SIN;
assert_eq!(
    format!("Your SIN is {}.", SIN::parse("046454286".to_string()).unwrap()),
    "Your SIN is 046-454-286.".to_string(),
);

impl PartialEq for SIN

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

impl Eq for SIN

impl StructuralPartialEq for SIN