Struct tinychain::cluster::Cluster

pub struct Cluster { /* fields omitted */ }

The data structure responsible for maintaining consensus per-transaction.

Implementations

impl Cluster

pub fn chain(&self, name: &Id) -> Option<&Chain>

Borrow one of this cluster’s Chains.

pub fn class(&self, name: &Id) -> Option<&InstanceClass>

Borrow an InstanceClass, if there is one defined with the given name.

pub fn public_key(&self) -> &[u8]

Borrow the public key of this cluster.

pub fn link(&self) -> &Link

Return the canonical Link to this cluster (probably not on this host).

pub fn path(&self) -> &[PathSegment]

Return the path of this cluster, relative to this host.

pub fn ns(&self) -> impl Iterator<Item = &Id>

Return the names of the members of this cluster.

pub async fn replicas(&self, txn_id: &TxnId) -> TCResult<HashSet<Link>>

Iterate over a list of replicas of this cluster.

pub async fn claim(&self, txn: &Txn) -> TCResult<Txn>

Claim ownership of the given Txn.

pub async fn authorize(&self, txn: &Txn, scope: &Scope) -> TCResult<()>

Return Unauthorized if the request does not have the given scope from a trusted issuer.

pub async fn grant(
    &self,
    txn: Txn,
    scope: Scope,
    op: OpDef,
    context: Map<State>
) -> TCResult<State>

Grant the given scope to the txn and use it to resolve the given OpRef.

pub async fn install(
    &self,
    txn_id: TxnId,
    other: Link,
    scopes: HashSet<Scope>
) -> TCResult<()>

Trust the Cluster at the given Link to issue the given auth Scopes.

pub async fn lead(&self, txn: Txn) -> TCResult<Txn>

Claim leadership of the given Txn.

pub async fn add_replica(&self, txn: &Txn, replica: Link) -> TCResult<()>

Add a replica to this cluster.

pub async fn remove_replicas(
    &self,
    txn: &Txn,
    to_remove: &[Link]
) -> TCResult<()>

Remove a replica from this cluster.

pub async fn replicate_write<F: Future<Output = TCResult<()>>, W: Fn(Link) -> F>(
    &self,
    txn: Txn,
    write: W
) -> TCResult<()>

pub async fn mutate(&self, txn: &Txn, participant: Link) -> TCResult<()>

pub async fn distribute_commit(&self, txn: Txn) -> TCResult<()>

pub async fn distribute_rollback(&self, txn: Txn)

pub async fn write_ahead(&self, txn_id: &TxnId)

Trait Implementations

impl Display for Cluster

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

Formats the value using the given formatter.

impl Hash for Cluster

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Instance for Cluster

type Class = ClusterType

The Class type of this instance

fn class(&self) -> Self::Class

Returns the [Class] of this instance.

impl PartialEq<Cluster> for Cluster

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Transact for Cluster

fn commit<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Commit this transaction.

fn finalize<'life0, 'life1, 'async_trait>(
    &'life0 self,
    txn_id: &'life1 TxnId
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Delete any version data specific to this transaction.

impl Eq for Cluster