Enum Region 

pub enum Region {
    Aws(AwsRegion),
}

Defines the region of a CipherStash service. A region in CipherStash is defined by the region identifier and the provider separated by a dot. For example, us-west-2.aws is a valid region identifier and refers to the AWS region us-west-2.

Variants

Aws(AwsRegion)

Implementations

impl Region

pub fn all() -> Vec<Region>

pub fn new(identifier: &str) -> Result<Region, RegionError>

Creates a new region from an identifier. Region identifiers are in the format <region>.<provider>.

For example, us-west-2.aws is a valid region identifier.

Example

use cts_common::{AwsRegion, Region};
let region = Region::new("us-west-2.aws").unwrap();
assert_eq!(region, Region::Aws(AwsRegion::UsWest2));

pub fn aws(identifier: &str) -> Result<Region, RegionError>

Creates a new AWS region from an identifier. Note that this is not the complete list of AWS regions, only the ones that are currently supported by CipherStash.

Example

use cts_common::{Region, AwsRegion};
let region = Region::aws("us-west-2").unwrap();
assert_eq!(region, Region::Aws(AwsRegion::UsWest2));

pub fn identifier(&self) -> String

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

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Region

impl Debug for Region

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Region

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Region

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

Formats the value using the given formatter.

impl Dummy<Faker> for Region

Available on crate feature test_utils only.

fn dummy_with_rng<R>(_: &Faker, rng: &mut R) -> Region

where R: Rng + ?Sized,

Generate a dummy value for a given type using a random number generator.

fn dummy(config: &T) -> Self

Generate a dummy value for a type.

impl Eq for Region

impl FromStr for Region

type Err = RegionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Region, <Region as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Region

fn eq(&self, other: &Region) -> 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 PartialEq<&str> for Region

fn eq(&self, other: &&str) -> 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 PartialSchema for Region

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for Region

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Region

impl ToSchema for Region

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.

impl TryFrom<(&str, &str)> for Region

Implement TryFrom for (&str, &str) to support the format “.”

Example

use cts_common::{AwsRegion, Region, RegionError};
use std::convert::TryFrom;

let region = Region::try_from(("us-west-2", "aws"));
assert_eq!(region, Ok(Region::Aws(AwsRegion::UsWest2)));

type Error = RegionError

The type returned in the event of a conversion error.

fn try_from( value: (&str, &str), ) -> Result<Region, <Region as TryFrom<(&str, &str)>>::Error>

Performs the conversion.