Struct BlockchainData

pub struct BlockchainData<T> { /* private fields */ }

Provides access to blockchain data for the executing service.

Implementations

impl<T: RawAccess + AsReadonly> BlockchainData<T>

pub fn new(access: T, instance_name: impl Into<String>) -> Self

Creates structured access to blockchain data based on the unstructured access (e.g., a Snapshot or a Fork) and the descriptor of the executing service.

pub fn instance_name(&self) -> &str

Returns the instance name of the executing service.

pub fn for_core(&self) -> CoreSchema<T::Readonly>

Returns core schema.

pub fn for_dispatcher(&self) -> DispatcherSchema<T::Readonly>

Returns dispatcher schema.

pub fn for_service<'q>( &self, id: impl Into<InstanceQuery<'q>>, ) -> Option<Prefixed<T::Readonly>>

Returns a mount point for another service. If the service with id does not exist, returns None.

Safety

This method does not check the service type; the caller is responsible for constructing a schema of a correct type around the returned access. Constructing an incorrect schema can lead to a panic or unexpected behavior. Use service_schema as a safer alternative, which performs all necessary checks.

pub fn service_schema<'q, S, I>( &self, service_id: I, ) -> Result<S, ArtifactReqError>

where S: RequireArtifact + FromAccess<Prefixed<T::Readonly>>, I: Into<InstanceQuery<'q>>,

Retrieves schema for a service.

Errors

Returns an error in the following situations (see ArtifactReqError for more details):

• Service with the given ID does not exist
• Service has an unexpected artifact name
• Service has an incompatible artifact version

pub fn for_executing_service(&self) -> Prefixed<T>

Returns a mount point for the data of the executing service instance. Unlike other data, this one may be writeable provided that this BlockchainData wraps a Fork.

impl BlockchainData<&dyn Snapshot>

pub fn proof_for_service_index(&self, index_name: &str) -> Option<IndexProof>

Returns a proof for a Merkelized index with the specified name in the currently executing service.

Return value

If the index does not exist or is not Merkelized, returns None. Note that this may occur before the index is accessed the first time, which, depending on the service logic, may happen indefinitely after the service has been initialized. Thus, unwrapping the returned value may unexpectedly lead to a panic unless the index is initialized early (e.g., during service initialization).

impl<'a, T> BlockchainData<T>

where T: Into<GenericRawAccess<'a>>,

pub fn erase_access(self) -> BlockchainData<GenericRawAccess<'a>>

Erases the enclosed access, converting it to the generic form.

Trait Implementations

impl<T: Clone> Clone for BlockchainData<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BlockchainData<T>

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

Formats the value using the given formatter.