Skip to main content

Location

Struct Location 

Source
pub struct Location(/* private fields */);
Expand description

Location (§11.1.5.7) — the node’s ISO 3166-1 alpha-2 region code.

A cell of its own rather than a field of BasicInformation, because two clusters write it: a client writing the attribute directly at Administer, and §11.10.7.4’s SetRegulatoryConfig, whose CountryCode “SHALL be used to set the Location attribute reflected by the Basic Information Cluster”. Sharing one cell is what keeps the two in agreement.

“The special value XX SHALL indicate that region-agnostic mode is used”, which is the fallback, and “The Location’s region code SHALL be interpreted in a case-insensitive manner”.

Implementations§

Source§

impl Location

Source

pub const fn region_agnostic() -> Self

The region-agnostic fallback, "XX".

Source

pub fn new(code: &str) -> Option<Self>

A location from a two-character region code.

Returns None for anything that is not exactly two characters, which is §11.1.5’s constraint 2 — a longer or shorter write is CONSTRAINT_ERROR, not a truncation.

Source

pub fn get(&self) -> [u8; 2]

The current region code.

Source

pub fn set(&self, code: &str) -> Result<(), Status>

Sets the region code, refusing anything that is not two ASCII characters.

Trait Implementations§

Source§

impl Debug for Location

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Location

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.