Struct Topology 

pub struct Topology<T: Clone + Debug> {
    pub name: TopologyName,
    pub config: T,
    /* private fields */
}

A named replication topology spanning multiple provider regions.

Example

use chroma_types::{Topology, TopologyName, RegionName};

let topology = Topology::new(
    TopologyName::new("us-multi-az").unwrap(),
    vec![
        RegionName::new("aws-us-east-1").unwrap(),
        RegionName::new("aws-us-west-2").unwrap(),
    ],
    (),
);
assert_eq!(topology.name().as_str(), "us-multi-az");
assert_eq!(topology.regions().len(), 2);

Fields

name: TopologyName

The unique name for this topology.

config: T

The configuration of this topology.

Implementations

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

pub fn new(name: TopologyName, regions: Vec<RegionName>, config: T) -> Self

Creates a new topology.

Example

use chroma_types::{Topology, TopologyName, RegionName};

let topology = Topology::new(
    TopologyName::new("global").unwrap(),
    vec![RegionName::new("aws-us-east-1").unwrap()],
    (),
);

pub fn name(&self) -> &TopologyName

Returns the unique name for this topology.

pub fn regions(&self) -> &[RegionName]

Returns the names of provider regions included in this topology.

pub fn config(&self) -> &T

Returns the additional per-topology configuration data.

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

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

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

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

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

Transforms this topology 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<Topology<U>, E>

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

Transforms this topology 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 Topology<T>

fn clone(&self) -> Topology<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 Topology<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Topology<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 Topology<T>

fn eq(&self, other: &Topology<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 Topology<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 Topology<T>

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