Struct flytrap::RegionCode

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

Available on crate feature regions only.

An unrecognized Fly.io region code.

If Flytrap parses a region code which doesn’t match any of the Region variants compiled into the crate, the bare value is preserved as a RegionCode.

use flytrap::{Location, Region};

let cairo: Location = "cai".parse()?;
let tokyo: Location = "nrt".parse()?;

assert_eq!(cairo, Location::Unknown("cai".parse()?));
assert_eq!(tokyo, Location::Region(Region::Tokyo));

Implementations

impl RegionCode

pub const LENGTH: usize = 3usize

The length in characters of a Fly.io region code.

pub const NULL_ISLAND: (R32, R32) = _

The geographic coordinates for “null island”, a fictitious landform at 0º latitude and longitude. Used as the coordinates for a Location::Unknown.

pub fn valid(input: &str) -> bool

Checks if the input passes for a Fly.io region code – /^[a-z]{3}$/.

use flytrap::RegionCode;

assert!(RegionCode::valid("oak"));
assert!(!RegionCode::valid("MDW"));
assert!(!RegionCode::valid("hi"));

Trait Implementations

impl AsRef<[u8]> for RegionCode

fn as_ref(&self) -> &[u8]

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

impl AsRef<str> for RegionCode

fn as_ref(&self) -> &str

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

impl Clone for RegionCode

fn clone(&self) -> RegionCode

Returns a copy 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<'de> Deserialize<'de> for RegionCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RegionCode

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

Formats the value using the given formatter.

impl From<Region> for RegionCode

fn from(value: Region) -> Self

Converts to this type from the input type.

impl From<RegionCode> for Location

fn from(value: RegionCode) -> Self

Converts to this type from the input type.

impl FromStr for RegionCode

type Err = RegionError

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 Ord for RegionCode

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RegionCode

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

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

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

This method 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: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RegionCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RegionCode

impl Eq for RegionCode

impl StructuralEq for RegionCode

impl StructuralPartialEq for RegionCode