Struct mz_storage_client::controller::CollectionState

pub struct CollectionState<T> {
    pub description: CollectionDescription<T>,
    pub read_capabilities: MutableAntichain<T>,
    pub implied_capability: Antichain<T>,
    pub read_policy: ReadPolicy<T>,
    pub storage_dependencies: Vec<GlobalId>,
    pub write_frontier: Antichain<T>,
    pub collection_metadata: CollectionMetadata,
}

State maintained about individual collections.

Fields

description: CollectionDescription<T>

Description with which the collection was created

read_capabilities: MutableAntichain<T>

Accumulation of read capabilities for the collection.

This accumulation will always contain self.implied_capability, but may also contain capabilities held by others who have read dependencies on this collection.

implied_capability: Antichain<T>

The implicit capability associated with collection creation. This should never be less than the since of the associated persist collection.

read_policy: ReadPolicy<T>

The policy to use to downgrade self.implied_capability.

storage_dependencies: Vec<GlobalId>

Storage identifiers on which this collection depends.

write_frontier: Antichain<T>

Reported write frontier.

collection_metadata: CollectionMetadata

Implementations

impl<T: Timestamp> CollectionState<T>

pub fn new(
    description: CollectionDescription<T>,
    since: Antichain<T>,
    write_frontier: Antichain<T>,
    storage_dependencies: Vec<GlobalId>,
    metadata: CollectionMetadata
) -> Self

Creates a new collection state, with an initial read policy valid from since.

fn cluster_id(&self) -> Option<StorageInstanceId>

Returns the cluster to which the collection is bound, if applicable.

Trait Implementations

impl<T: Debug> Debug for CollectionState<T>

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

Formats the value using the given formatter.