Struct CountryCode 

#[repr(transparent)]
pub struct CountryCode {
    pub(crate) inner: NonZeroU16,
}

A two-letter country code.

Specifically, this type represents a purported “ISO 3166-1 alpha-2” country code, such as “IT” for Italy or “UY” for Uruguay.

It does not include the sentinel value ?? that we use to represent “country unknown”; if you need that, use OptionCc. Other than that, we do not check whether the country code represents a real country: we only ensure that it is a pair of printing ASCII characters.

Note that the geoip databases included with Arti will only include real countries; we do not include the pseudo-countries A1 through An for “anonymous proxies”, since doing so would mean putting nearly all Tor relays into one of those countries.

Fields

inner: NonZeroU16

The underlying value (two printable ASCII characters, stored uppercase).

The special value ?? is excluded, since it is not a country; use OptionCc instead if you need to represent that.

We store these as NonZeroU16 so that an Option<CountryCode> only has to take 2 bytes. This helps with alignment and storage.

(We use a NonZeroU16 rather than [NonZeroU8; 2] to ensure that every bit representation is a valid Option<CountryCode>.)

Implementations

impl CountryCode

pub(crate) fn new(cc_orig: &str) -> Result<Self, Error>

Make a new CountryCode.

pub fn get(&self) -> &str

Get the actual country code.

This just calls .as_ref().

Trait Implementations

impl AsRef<str> for CountryCode

fn as_ref(&self) -> &str

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

impl Clone for CountryCode

fn clone(&self) -> CountryCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CountryCode

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

Formats the value using the given formatter.

impl Display for CountryCode

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

Formats the value using the given formatter.

impl FromStr for CountryCode

type Err = Error

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

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

impl Eq for CountryCode

impl StructuralPartialEq for CountryCode