Struct jurisdiction::Jurisdiction

pub struct Jurisdiction { /* fields omitted */ }

A pointer sized object encoding countries and areas of the world.

The size of this structure is minimized such that passing it around will be limited overhead, with implemented methods performing lookup in static table instead.

Methods

impl Jurisdiction

pub fn name(&self) -> &str

Return the english name of this jurisdiction.

pub fn country_code(&self) -> u16

Return the ISO-3166 numeric country code made up of 3 characters.

Origin

The definition is sourced from ISO-3166 standard.

pub fn alpha2(&self) -> Alpha2

Return the two letter Alpha2 representation for this Jurisdiction.

Origin

The definition is sourced from ISO-3166 standard.

pub fn alpha3(&self) -> Alpha3

Return the two letter Alpha3 representation for this Jurisdiction.

Origin

The definition is sourced from the ISO-3166 standard.

pub fn region(&self) -> Region

Return the Region on earth this Jurisdiction is situated in.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn sub_region(&self) -> SubRegion

Return the SubRegion of a Region this Jurisdiction is situated in.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn intermediate_region(&self) -> IntermediateRegion

Return the IntermediateRegion of a SubRegion this Jurisdiction is situated in.

Not all Jursidictions has a defined IntermediateRegion. These will thus return Undefined.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn region_code(&self) -> u16

Return the 3 character numeric identifier for the Region this Jurisdiction is situated in.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn sub_region_code(&self) -> u16

Return the 3 character numeric identifier for the SubRegion this Jurisdiction is situated in.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn intermediate_region_code(&self) -> Option<u16>

Return the 3 character numeric identifier for the IntermediateRegion this Jurisdiction is situated in.

Origin

The definition is sourced from the statistics division of the UN for standard country and area codes for statistical use (M49).

pub fn in_region(region: Region) -> Vec<Jurisdiction>

Return all Jurisdictions zoning to specified region.

pub fn in_sub_region(sub: SubRegion) -> Vec<Jurisdiction>

Return all Jurisdictions zoning to specified sub region.

pub fn in_intermediate_region(inter: IntermediateRegion) -> Vec<Jurisdiction>

Return all Jurisdictions zoning to specified sub region.

Trait Implementations

impl Clone for Jurisdiction

fn clone(&self) -> Jurisdiction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Jurisdiction

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

Formats the value using the given formatter.

impl From<Alpha2> for Jurisdiction

fn from(alpha: Alpha2) -> Self

Performs the conversion.

impl From<Alpha3> for Jurisdiction

fn from(alpha: Alpha3) -> Self

Performs the conversion.

impl FromStr for Jurisdiction

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<Alpha2> for Jurisdiction

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Alpha3> for Jurisdiction

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Jurisdiction> for Jurisdiction

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.