Struct casper_node::storage::Storage

pub struct Storage { /* private fields */ }

The storage component.

Implementations

impl Storage

pub fn new( cfg: &WithDir<Config>, hard_reset_to_start_of_era: Option<EraId>, protocol_version: ProtocolVersion, activation_era: EraId, network_name: &str, max_ttl: MaxTtl, recent_era_count: u64, registry: Option<&Registry>, force_resync: bool ) -> Result<Self, FatalStorageError>

Creates a new storage component.

pub fn put_deploy(&self, deploy: &Deploy) -> Result<bool, FatalStorageError>

Put a single deploy into storage.

pub fn read_block( &self, block_hash: &BlockHash ) -> Result<Option<Block>, FatalStorageError>

Retrieves a block by hash.

pub fn read_highest_block(&self) -> Result<Option<Block>, FatalStorageError>

Gets the highest block.

pub fn read_highest_block_header( &self ) -> Result<Option<BlockHeader>, FatalStorageError>

Retrieves the highest block header from the storage, if one exists.

pub fn write_block(&mut self, block: &Block) -> Result<bool, FatalStorageError>

Writes a block to storage, updating indices as necessary.

Returns Ok(true) if the block has been successfully written, Ok(false) if a part of it couldn’t be written because it already existed, and Err(_) if there was an error.

pub fn write_complete_block( &mut self, block: &Block ) -> Result<bool, FatalStorageError>

Writes a block to storage and marks it as complete, updating indices as necessary.

Returns Ok(true) if the block has been successfully written, Ok(false) if a part of it couldn’t be written because it already existed, and Err(_) if there was an error. This function guarantees that either both the block storing and the completed_blocks index update were successful or that the entire operation was reverted.

pub fn read_highest_block_height(&self) -> Option<u64>

Retrieves the highest block header from the storage, if one exists.

pub fn read_block_header_by_height( &self, height: u64, only_from_available_block_range: bool ) -> Result<Option<BlockHeader>, FatalStorageError>

Retrieves a single block header by height by looking it up in the index and returning it.

pub fn read_block_header( &self, block_hash: &BlockHash ) -> Result<Option<BlockHeader>, FatalStorageError>

Retrieves a single block header by hash.

pub fn read_block_by_height( &self, height: u64 ) -> Result<Option<Block>, FatalStorageError>

Retrieves single block by height by looking it up in the index and returning it.

pub fn read_block_and_metadata_by_height( &self, height: u64 ) -> Result<Option<BlockWithMetadata>, FatalStorageError>

Retrieves a block by height, together with all stored block signatures.

Returns None if the block is not stored, or if no block signatures are stored for it.

pub fn read_deploy_by_hash( &self, deploy_hash: &DeployHash ) -> Result<Option<Deploy>, FatalStorageError>

Directly returns a deploy from internal store.

Trait Implementations

impl DataSize for Storage

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

fn estimate_detailed_heap_size(&self) -> MemUsageNode

Create a tree of memory estimations.

impl Debug for Storage

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

Formats the value using the given formatter.