Struct tinychain::cluster::Cluster

source · 
pub struct Cluster<T> { /* private fields */ }
Expand description

The data structure responsible for maintaining consensus per-transaction across the network.

Implementations§

source§

impl<T> Cluster<T>

source

pub fn schema(&self) -> &Schema

Borrow the Schema of this Cluster.

Return a canonical [Link] to this Cluster (probably not on this host).

source

pub fn state(&self) -> &T

Borrow the state managed by this Cluster

source

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

Borrow the path of this Cluster, relative to this host.

source

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

Borrow the public key of this replica.

source

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

Claim ownership of the given Txn.

source

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

Claim leadership of the given Txn.

source§

impl<T> Cluster<T>
where T: Transact + Send + Sync,

source

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

Register a participant in the given Txn.

source

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

Claim leadership of this Txn, then commit all replicas.

source

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

Commit the given Txn for all members of this Cluster.

source

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

Roll back the given Txn for all members of this Cluster.

source§

impl<T> Cluster<T>
where T: Replica + Send + Sync,

source

pub async fn replicas( &self, txn_id: TxnId ) -> TCResult<impl Deref<Target = BTreeSet<Host>>>

Get the set of current replicas of this Cluster.

source

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

Add a replica to this Cluster.

Returns true if a new replica was added.

source

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

Claim leadership of the given Txn and add a replica to this Cluster.

source

pub async fn remove_replicas<'a, R: IntoIterator<Item = &'a Host>>( &'a self, txn_id: TxnId, to_remove: R ) -> TCResult<()>

Remove one or more replicas from this Cluster.

source

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

Replicate the given write operation across all other replicas of this Cluster.

source§

impl<T> Cluster<Dir<T>>
where T: Clone,

source

pub fn lookup<'a>( &self, txn_id: TxnId, path: &'a [PathSegment] ) -> TCResult<(&'a [PathSegment], DirEntry<T>)>

Trait Implementations§

source§

impl<T: Clone> Clone for Cluster<T>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for Cluster<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T: Transact + Clone + Send + Sync + 'static> Dispatch for Cluster<Dir<T>>
where Cluster<BlockChain<T>>: Route<State>, BlockChain<T>: Replica, Dir<T>: Replica, Self: Route<State>,

source§

fn get<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 Txn, path: &'life2 [PathSegment], key: Value ) -> Pin<Box<dyn Future<Output = TCResult<State>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Route a GET request.
source§

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 Txn, path: &'life2 [PathSegment], key: Value, value: State ) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Route a PUT request.
source§

fn post<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 Txn, path: &'life2 [PathSegment], data: State ) -> Pin<Box<dyn Future<Output = TCResult<State>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Route a POST request.
source§

fn delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 Txn, path: &'life2 [PathSegment], key: Value ) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Route a DELETE request.
source§

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

Finalize a transaction
source§

impl<T> Persist<CacheBlock> for Cluster<BlockChain<T>>
where T: Persist<CacheBlock, Txn = Txn>, BlockChain<T>: Persist<CacheBlock, Schema = (), Txn = Txn>,

§

type Txn = Txn<State>

§

type Schema = Schema

source§

fn create<'async_trait>( txn_id: TxnId, schema: Self::Schema, store: Dir ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>
where Self: 'async_trait,

Create a new instance of Self from an empty Store.
source§

fn load<'async_trait>( txn_id: TxnId, schema: Self::Schema, store: Dir ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>
where Self: 'async_trait,

Load a saved instance of Self from persistent storage. Should only be invoked at startup time.
source§

fn dir(&self) -> Inner<CacheBlock>

Access the filesystem directory backing this persistent data structure.
source§

impl<T> Persist<CacheBlock> for Cluster<Dir<T>>
where T: Persist<CacheBlock, Txn = Txn>, Dir<T>: Persist<CacheBlock, Schema = Schema, Txn = Txn>,

§

type Txn = Txn<State>

§

type Schema = Schema

source§

fn create<'async_trait>( txn_id: TxnId, schema: Self::Schema, store: Dir ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>
where Self: 'async_trait,

Create a new instance of Self from an empty Store.
source§

fn load<'async_trait>( txn_id: TxnId, schema: Self::Schema, store: Dir ) -> Pin<Box<dyn Future<Output = TCResult<Self>> + Send + 'async_trait>>
where Self: 'async_trait,

Load a saved instance of Self from persistent storage. Should only be invoked at startup time.
source§

fn dir(&self) -> Inner<CacheBlock>

Access the filesystem directory backing this persistent data structure.
source§

impl<T> Recover<CacheBlock> for Cluster<T>
where T: Recover<CacheBlock, Txn = Txn> + Send + Sync,

§

type Txn = Txn<State>

source§

fn recover<'life0, 'life1, 'async_trait>( &'life0 self, txn: &'life1 Txn ) -> Pin<Box<dyn Future<Output = TCResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Recover this state after loading, in case the last transaction failed or was interrupted.
source§

impl<T> Route<State> for Cluster<T>
where T: Replica + Route<State> + Transact + Debug + Send + Sync,

source§

fn route<'a>( &'a self, path: &'a [PathSegment] ) -> Option<Box<dyn Handler<'a, State> + 'a>>

source§

impl<T> Transact for Cluster<T>
where T: Transact + Send + Sync,

§

type Commit = Arc<BTreeSet<Host>>

A guard which blocks concurrent commits
source§

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

Commit this transaction.
source§

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

Roll back this transaction.
source§

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

Delete any version data specific to this transaction.

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for Cluster<T>

§

impl<T> Send for Cluster<T>
where T: Send,

§

impl<T> Sync for Cluster<T>
where T: Sync,

§

impl<T> Unpin for Cluster<T>
where T: Unpin,

§

impl<T> !UnwindSafe for Cluster<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<F, T> CastFrom<F> for T
where T: From<F>,

source§

fn cast_from(f: F) -> T

Cast an instance of T into an instance of Self.
source§

impl<T, F> CastInto<F> for T
where F: CastFrom<T>,

source§

fn cast_into(self) -> F

Cast an instance of Self into an instance of T.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<F> Match for F

source§

fn matches<T>(&self) -> bool
where T: TryCastFrom<Self>,

Returns true if self can be cast into the target type T.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<State, T> Public<State> for T
where State: StateInstance, T: Route<State> + Debug,

source§

fn get<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value ) -> Pin<Box<dyn Future<Output = Result<State, TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

source§

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value, value: State ) -> Pin<Box<dyn Future<Output = Result<(), TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

source§

fn post<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], params: Map<State> ) -> Pin<Box<dyn Future<Output = Result<State, TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

source§

fn delete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, txn: &'life1 <State as StateInstance>::Txn, path: &'life2 [Id], key: Value ) -> Pin<Box<dyn Future<Output = Result<(), TCError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait,

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<State, T> ToState<State> for T
where State: StateInstance, T: Clone + Into<State>,

source§

fn to_state(&self) -> State

source§

impl<F, T> TryCastFrom<F> for T
where T: CastFrom<F>,

source§

fn can_cast_from(_: &F) -> bool

Test if value can be cast into Self.
source§

fn opt_cast_from(f: F) -> Option<T>

Returns Some(Self) if the source value can be cast into Self, otherwise None.
source§

fn try_cast_from<Err, OnErr>(value: T, on_err: OnErr) -> Result<Self, Err>
where OnErr: FnOnce(&T) -> Err,

Returns Ok(Self) if the source value can be cast into Self, otherwise calls on_err.
source§

impl<F, T> TryCastInto<T> for F
where T: TryCastFrom<F>,

source§

fn can_cast_into(&self) -> bool

Test if self can be cast into T.
source§

fn opt_cast_into(self) -> Option<T>

Returns Some(T) if self can be cast into T, otherwise None.
source§

fn try_cast_into<Err, OnErr>(self, on_err: OnErr) -> Result<T, Err>
where OnErr: FnOnce(&Self) -> Err,

Returns Ok(T) if self can be cast into T, otherwise calls on_err.
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> ThreadSafe for T
where T: Send + Sync + 'static,