Struct ProviderRegion 

pub struct ProviderRegion<T: Clone + Debug> {
    pub name: RegionName,
    pub provider: String,
    pub region: String,
    pub config: T,
}

A cloud provider and geographic region.

Example

use chroma_types::{ProviderRegion, RegionName};

let region = ProviderRegion::new(
    RegionName::new("aws-us-east-1").unwrap(),
    "aws",
    "us-east-1",
    (),
);
assert_eq!(region.name().as_str(), "aws-us-east-1");
assert_eq!(region.provider(), "aws");
assert_eq!(region.region(), "us-east-1");

Fields

name: RegionName

The unique name for this provider-region combination.

provider: String

The cloud provider (e.g., “aws”, “gcp”).

region: String

The region within the provider (e.g., “us-east-1”, “europe-west1”).

config: T

Additional per-region data.

Implementations

impl<T: Clone + Debug> ProviderRegion<T>

pub fn new( name: RegionName, provider: impl Into<String>, region: impl Into<String>, config: T, ) -> Self

Creates a new provider region.

Example

use chroma_types::{ProviderRegion, RegionName};

let region = ProviderRegion::new(
    RegionName::new("gcp-europe-west1").unwrap(),
    "gcp",
    "europe-west1",
    (),
);

pub fn name(&self) -> &RegionName

Returns the unique name for this provider-region combination.

pub fn provider(&self) -> &str

Returns the cloud provider (e.g., “aws”, “gcp”).

pub fn region(&self) -> &str

Returns the region within the provider (e.g., “us-east-1”, “europe-west1”).

pub fn config(&self) -> &T

Returns the additional per-region configuration data.

pub fn cast<U, F>(self, f: F) -> ProviderRegion<U>

where U: Clone + Debug, F: FnOnce(T) -> U,

Transforms this provider region into a new type by applying a function to the config.

pub fn try_cast<U, E, F>(self, f: F) -> Result<ProviderRegion<U>, E>

where U: Clone + Debug, F: FnOnce(T) -> Result<U, E>,

Transforms this provider region into a new type by applying a fallible function to the config.

Errors

Returns an error if the transformation function returns an error.

pub async fn try_cast_async<U, E, F, R>( self, f: F, ) -> Result<ProviderRegion<U>, E>

where U: Clone + Debug, F: FnOnce(T) -> R, R: Future<Output = Result<U, E>> + Send,

Transforms this provider region into a new type by applying an async fallible function to the config.

Errors

Returns an error if the transformation function returns an error.

Trait Implementations

impl<T: Clone + Clone + Debug> Clone for ProviderRegion<T>

fn clone(&self) -> ProviderRegion<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone + Debug> Debug for ProviderRegion<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for ProviderRegion<T>

where T: Clone + Debug + DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq + Clone + Debug> PartialEq for ProviderRegion<T>

fn eq(&self, other: &ProviderRegion<T>) -> 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<T> Serialize for ProviderRegion<T>

where T: Clone + Debug + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq + Clone + Debug> Eq for ProviderRegion<T>

impl<T: Clone + Debug> StructuralPartialEq for ProviderRegion<T>