Struct EngineHandle 

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

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,

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

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

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

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

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

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

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

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

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

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

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

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

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,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

where CS: ChainStore, PS: PendingStore,

fn drop(&mut self)

Executes the destructor for this type.