Struct NHSNumber 

pub struct NHSNumber {
    pub digits: [i8; 10],
}

NHS Number is a unique identifier for patients in the National Health Service of England, Wales, and the Isle of Man.

Reference:

• National Health Service (NHS)

• NHS Number

use nhs_number::NHSNumber;
let digits = [9, 9, 9, 1, 2, 3, 4, 5, 6, 0];
let nhs_number = NHSNumber { digits: digits };

Fields

digits: [i8; 10]

Implementations

impl NHSNumber

pub fn new(digits: [i8; 10]) -> Self

Create a new NHS Number instance with the provided digits.

Example:

use nhs_number::NHSNumber;
let digits = [9, 9, 9, 1, 2, 3, 4, 5, 6, 0];
let nhs_number = NHSNumber::new(digits);

pub fn check_digit(&self) -> i8

Get the NHS Number check digit i.e. the last digit.

Example:

use nhs_number::NHSNumber;
let digits = [9, 9, 9, 1, 2, 3, 4, 5, 6, 0];
let nhs_number = NHSNumber::new(digits);
let check_digit = nhs_number.check_digit();
assert_eq!(check_digit, 0);

This method calls the function check_digit().

pub fn calculate_check_digit(&self) -> i8

Calculate the NHS Number check digit using a checksum algorithm.

Example:

use nhs_number::NHSNumber;
let digits = [9, 9, 9, 1, 2 , 3, 4, 5, 6, 0];
let nhs_number = NHSNumber::new(digits);
let check_digit = nhs_number.calculate_check_digit();
assert_eq!(check_digit, 0);

This method calls the function calculate_check_digit().

pub fn validate_check_digit(&self) -> bool

Validate the NHS Number check digit equals the calculated check digit.

Example:

use nhs_number::NHSNumber;
let digits = [9, 9, 9, 1, 2, 3, 4, 5, 6, 0];
let nhs_number = NHSNumber::new(digits);
let is_valid = nhs_number.validate_check_digit();
assert_eq!(is_valid, true);

This method calls the function validate_check_digit().

pub fn testable_random_sample() -> NHSNumber

Generate a testable random sample NHS Number.

Example:

use nhs_number::{NHSNumber, testable::{TESTABLE_MIN, TESTABLE_MAX}};
let sample = NHSNumber::testable_random_sample();
assert!(sample >= *TESTABLE_MIN);
assert!(sample <= *TESTABLE_MAX);

This method calls the function testable_random_sample().

Trait Implementations

impl Clone for NHSNumber

fn clone(&self) -> NHSNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NHSNumber

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NHSNumber

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NHSNumber

Format the NHS Number as a 10-digit number with spaces.

Example:

use nhs_number::NHSNumber;
let digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
let nhs_number = NHSNumber::new(digits);
let nhs_number_string = nhs_number.to_string();
assert_eq!(nhs_number_string, "012 345 6789");

The NHS Number is formatted as a 10-digit number with spaces:

• 3 digits
• space
• 3 digits
• space
• 4 digits

This method must be equivalent to the function format().

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

Formats the value using the given formatter.

impl FromStr for NHSNumber

Implement the FromStr trait for NHSNumber to allow parsing from a string.

This parser allows for optional space separators in the NHS Number string, so long as the space separators are in their expected positions.

A valid NHS Number format can be either:

• 10 digits e.g. “0123456789”

• 12 characters with spaces e.g. “012 345 6789”.

Example:

use nhs_number::NHSNumber;
use std::str::FromStr;
let nhs_number_str = "012 345 6789";
let nhs_number: NHSNumber = NHSNumber::from_str(nhs_number_str).unwrap();
assert_eq!(nhs_number.digits, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);

type Err = ParseError

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 Into<String> for NHSNumber

Convert the NHSNumber into a String.

Example:

use nhs_number::NHSNumber;
let digits = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9];
let nhs_number = NHSNumber::new(digits);
let nhs_number_string: String = nhs_number.into();
assert_eq!(nhs_number_string, "012 345 6789");

fn into(self) -> String

Converts this type into the (usually inferred) input type.

impl Ord for NHSNumber

fn cmp(&self, other: &NHSNumber) -> 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 NHSNumber

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

fn partial_cmp(&self, other: &NHSNumber) -> 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 NHSNumber

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for NHSNumber

impl Eq for NHSNumber

impl StructuralPartialEq for NHSNumber