Struct exocore_chain::EngineHandle[][src]

pub struct EngineHandle<CS, PS> where
    CS: ChainStore,
    PS: PendingStore
{ /* fields omitted */ }

Handle ot the Engine, allowing communication with the engine. The engine itself is owned by a future executor.

Implementations

impl<CS, PS> EngineHandle<CS, PS> where
    CS: ChainStore,
    PS: PendingStore
[src]

pub fn on_started(&self) -> impl Future<Output = ()>[src]

pub fn write_entry_operation(
    &self,
    data: &[u8]
) -> Result<OperationId, EngineError>
[src]

pub fn get_chain_segments(&self) -> Result<Segments, EngineError>[src]

pub fn get_chain_operation(
    &self,
    block_offset: BlockOffset,
    operation_id: OperationId
) -> Result<Option<EngineOperation>, EngineError>
[src]

pub fn get_chain_operations(
    &self,
    from_offset: Option<BlockOffset>
) -> ChainOperationsIterator<CS, PS>
[src]

pub fn get_chain_last_block_info(
    &self
) -> Result<Option<(BlockOffset, BlockHeight)>, EngineError>
[src]

pub fn get_chain_block_info(
    &self,
    offset: BlockOffset
) -> Result<Option<(BlockOffset, BlockHeight)>, EngineError>
[src]

pub fn get_chain_block(
    &self,
    offset: BlockOffset
) -> Result<Option<DataBlock<ChainData>>, EngineError>
[src]

pub fn get_pending_operation(
    &self,
    operation_id: OperationId
) -> Result<Option<EngineOperation>, EngineError>
[src]

pub fn get_pending_operations<R: RangeBounds<OperationId>>(
    &self,
    operations_range: R
) -> Result<Vec<EngineOperation>, EngineError>
[src]

pub fn get_operation(
    &self,
    operation_id: OperationId
) -> Result<Option<EngineOperation>, EngineError>
[src]

pub fn take_events_stream(
    &mut self
) -> Result<impl Stream<Item = Event>, EngineError>
[src]

Take the events stream receiver out of this Handle. This stream is bounded and consumptions should be non-blocking to prevent losing events. Calling the engine on every call should be throttled in the case of a big read amplification.

Trait Implementations

impl<CS, PS> Clone for EngineHandle<CS, PS> where
    CS: ChainStore,
    PS: PendingStore
[src]

impl<CS, PS> Drop for EngineHandle<CS, PS> where
    CS: ChainStore,
    PS: PendingStore
[src]

Auto Trait Implementations

impl<CS, PS> !RefUnwindSafe for EngineHandle<CS, PS>

impl<CS, PS> Send for EngineHandle<CS, PS>

impl<CS, PS> Sync for EngineHandle<CS, PS>

impl<CS, PS> Unpin for EngineHandle<CS, PS>

impl<CS, PS> !UnwindSafe for EngineHandle<CS, PS>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> CloneAny for T where
    T: Any + Clone

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> UnsafeAny for T where
    T: Any

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