Struct RegionCode 

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

A 2-byte region identifier.

let sjc: RegionCode = "SJC".parse().unwrap();
assert_eq!(sjc.to_bytes(), [0x78, 0x53]);
assert_eq!(sjc.to_string(), "SJC");

let oregon: RegionCode = "OR".parse().unwrap();
assert_eq!(oregon.to_string(), "OR");

let valley: RegionCode = "Rogue Valley".parse().unwrap();
assert_eq!(valley.to_string(), "0xC0F9");

Implementations

impl RegionCode

pub const fn from_u16(value: u16) -> Self

Wrap a raw code.

pub const fn as_u16(self) -> u16

Return the raw code.

pub const fn from_bytes(bytes: [u8; 2]) -> Self

Wrap a code from its two wire bytes.

pub const fn to_bytes(self) -> [u8; 2]

Return the code’s two wire bytes.

pub fn from_short_code(code: &str) -> Result<Self, RegionCodeError>

Encode a short code: one to three ASCII letters or digits.

Case-insensitive. Anything longer, or bearing a character ARNCE spells but a region may not use, is rejected, so that named regions cannot be mistaken for short codes.

An all-letter code is exclusive — no named region can derive it — and so reads back as itself. One bearing a digit encodes just as faithfully but shares its space with the hashes, so it does not.

pub fn from_name(name: &str) -> Self

Derive the code for a named region.

ASCII letters are folded to lowercase before hashing, so spellings that differ only in case are the same region. No other bytes are altered; a name containing non-ASCII characters hashes those bytes verbatim.

pub fn letters(self) -> Option<Letters>

Return the letters this code decodes to, if it decodes to letters at all.

Some means the code came from an all-letter short code: named regions are transformed out of this space by construction. A code decoding to anything else, digits included, has no reading and returns None.

Trait Implementations

impl Clone for RegionCode

fn clone(&self) -> RegionCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionCode

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

Formats the value using the given formatter.

impl Display for RegionCode

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

Formats the value using the given formatter.

impl From<[u8; 2]> for RegionCode

fn from(bytes: [u8; 2]) -> Self

Converts to this type from the input type.

impl From<RegionCode> for [u8; 2]

fn from(code: RegionCode) -> Self

Converts to this type from the input type.

impl FromStr for RegionCode

Parse a region code from its textual form.

0x followed by exactly four hex digits is the code it spells, one to three ASCII letters or digits is a short code, and anything else is a region name. The derivation is total over every string of one to REGION_NAME_MAX_LEN bytes: a string that merely looks like a literal code — 0x12, 0xzz — is not one, and is hashed as the name it is (packet-options.md § Region Code Encoding).

type Err = RegionCodeError

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 RegionCode

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 RegionCode

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

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

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

impl Eq for RegionCode

impl StructuralPartialEq for RegionCode