Skip to main content

Region

Enum Region 

Source
#[non_exhaustive]
pub enum Region { Eu868, Us915, Eu433, Au915, Cn470, As923, Kr920, In865, Ru864, }
Expand description

A named regional channel plan.

This is a convenience over ChannelPlan, not the only way to get one: a deployment on licensed spectrum builds its own plan and every method still applies. Each variant is behind its own cargo feature.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Eu868

Europe and everywhere else following ETSI EN 300 220, 863-870 MHz.

§

Us915

The United States, Canada, and ITU Region 2, 902-928 MHz.

§

Eu433

The 433 MHz ISM band.

§

Au915

Australia and the countries following it, 915-928 MHz.

§

Cn470

China, 470-510 MHz.

§

As923

Asia and the Pacific, 923 MHz.

§

Kr920

South Korea, 920-923 MHz.

§

In865

India, 865-867 MHz.

§

Ru864

Russia, 864-870 MHz.

Implementations§

Source§

impl Region

Source

pub const fn plan(self) -> &'static ChannelPlan<'static>

Returns the channel plan this region names.

§Returns

The plan, whose tables come straight from RP002-1.0.5.

Source

pub const fn name(self) -> &'static str

Returns the specification’s name for this region’s band.

§Returns

The band name, such as "EU863-870".

Source

pub const fn code(self) -> &'static str

Returns the short code this region is configured by.

A deployment is set up as EU868 or US915; the band name the specification uses, such as EU863-870, is what name reports. Both identify the same plan.

§Returns

The short code, such as "EU868".

§Examples
use pamoja_lora::region::Region;

assert_eq!(Region::Eu868.code(), "EU868");
assert_eq!(Region::Eu868.name(), "EU863-870");
Source

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

Returns the region a short code names.

The comparison ignores case, and the specification’s band name is accepted as well, so a plan read back from a device’s configuration resolves whichever form it was written in.

§Arguments
  • code - the short code or band name, such as "EU868".
§Returns

The region, or None if no region in this build goes by that name.

§Examples
use pamoja_lora::region::Region;

assert_eq!(Region::from_code("us915"), Some(Region::Us915));
assert_eq!(Region::from_code("US902-928"), Some(Region::Us915));
assert_eq!(Region::from_code("Atlantis"), None);
Source

pub const fn all() -> &'static [Region]

Returns every region this build carries.

A build that selects only its own region gets a one-element slice, which is the point of the per-region features.

§Returns

The compiled-in regions.

Trait Implementations§

Source§

impl Clone for Region

Source§

fn clone(&self) -> Region

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Region

Source§

impl Debug for Region

Source§

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

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

impl Eq for Region

Source§

impl Hash for Region

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Region

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Region

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.