Struct mz_sql::catalog::EnvironmentId

pub struct EnvironmentId {
    cloud_provider: CloudProvider,
    cloud_provider_region: String,
    organization_id: Uuid,
    ordinal: u64,
}

Identifies an environment.

Outside of tests, an environment ID can be constructed only from a string of the following form:

<CLOUD PROVIDER>-<CLOUD PROVIDER REGION>-<ORGANIZATION ID>-<ORDINAL>

The fields have the following formats:

• The cloud provider consists of one or more alphanumeric characters.
• The cloud provider region consists of one or more alphanumeric or hyphen characters.
• The organization ID is a UUID in its canonical text format.
• The ordinal is a decimal number with between one and eight digits.

There is no way to construct an environment ID from parts, to ensure that the Display representation is parseable according to the above rules.

Fields

cloud_provider: CloudProvider

cloud_provider_region: String

organization_id: Uuid

ordinal: u64

Implementations

impl EnvironmentId

pub fn for_tests() -> EnvironmentId

Creates a dummy EnvironmentId for use in tests.

pub fn cloud_provider(&self) -> &CloudProvider

Returns the cloud provider associated with this environment ID.

pub fn cloud_provider_region(&self) -> &str

Returns the cloud provider region associated with this environment ID.

pub fn region(&self) -> String

Returns the name of the region associted with this environment ID.

A region is a combination of EnvironmentId::cloud_provider and EnvironmentId::cloud_provider_region.

pub fn organization_id(&self) -> Uuid

Returns the organization ID associated with this environment ID.

pub fn ordinal(&self) -> u64

Returns the ordinal associated with this environment ID.

Trait Implementations

impl Clone for EnvironmentId

fn clone(&self) -> EnvironmentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentId

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

Formats the value using the given formatter.

impl Display for EnvironmentId

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

Formats the value using the given formatter.

impl FromStr for EnvironmentId

type Err = InvalidEnvironmentIdError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<EnvironmentId, InvalidEnvironmentIdError>

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

impl PartialEq for EnvironmentId

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