Struct FileSystemStorage

pub struct FileSystemStorage<Types: NodeType>
where
    Header<Types>: QueryableHeader<Types>,
    Payload<Types>: QueryablePayload<Types>,
{
    inner: RwLock<FileSystemStorageInner<Types>>,
    metrics: PrometheusMetrics,
}

Storage for the APIs provided in this crate, backed by a remote PostgreSQL database.

Fields

inner: RwLock<FileSystemStorageInner<Types>>

metrics: PrometheusMetrics

Implementations

impl<Types: NodeType> FileSystemStorage<Types>

where Payload<Types>: QueryablePayload<Types>, Header<Types>: QueryableHeader<Types>,

pub async fn create(path: &Path) -> Result<Self, PersistenceError>

Create a new FileSystemStorage with storage at path.

If there is already data at path, it will be archived.

The FileSystemStorage will manage its own persistence synchronization.

pub async fn open(path: &Path) -> Result<Self, PersistenceError>

Open an existing FileSystemStorage from storage at path.

If there is no data at path, a new store will be created.

The FileSystemStorage will manage its own persistence synchronization.

pub async fn create_with_store( loader: &mut AtomicStoreLoader, ) -> Result<Self, PersistenceError>

Create a new FileSystemStorage using a persistent storage loader.

If there is existing data corresponding to the FileSystemStorage data structures, it will be archived.

The FileSystemStorage will register its persistent data structures with loader. The caller is responsible for creating an [AtomicStore] from loader and managing synchronization of the store.

pub async fn open_with_store( loader: &mut AtomicStoreLoader, ) -> Result<Self, PersistenceError>

Open an existing FileSystemStorage using a persistent storage loader.

If there is no existing data corresponding to the FileSystemStorage data structures, a new store will be created.

The FileSystemStorage will register its persistent data structures with loader. The caller is responsible for creating an [AtomicStore] from loader and managing synchronization of the store.

pub async fn skip_version(&self) -> Result<(), PersistenceError>

Advance the version of the persistent store without committing changes to persistent state.

pub async fn get_vid_share( &self, block_id: BlockId<Types>, ) -> QueryResult<VidShare>

Get the stored VID share for a given block, if one exists.

pub async fn get_vid_common( &self, block_id: BlockId<Types>, ) -> QueryResult<VidCommonQueryData<Types>>

Get the stored VID common data for a given block, if one exists.

pub async fn get_vid_common_metadata( &self, block_id: BlockId<Types>, ) -> QueryResult<VidCommonMetadata<Types>>

Get the stored VID common metadata for a given block, if one exists.

Trait Implementations

impl<Types: Debug + NodeType> Debug for FileSystemStorage<Types>

where Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

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

Formats the value using the given formatter.

impl<Types> HasMetrics for FileSystemStorage<Types>

where Types: NodeType, Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

fn metrics(&self) -> &PrometheusMetrics

impl<Types: NodeType> MigrateTypes<Types> for FileSystemStorage<Types>

where Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

fn migrate_types<'life0, 'async_trait>( &'life0 self, _batch_size: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl<Types: NodeType> PruneStorage for FileSystemStorage<Types>

where Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

type Pruner = ()

fn get_disk_usage<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

fn prune<'life0, 'life1, 'async_trait>( &'life0 self, _pruner: &'life1 mut Self::Pruner, ) -> Pin<Box<dyn Future<Output = Result<Option<u64>>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn vacuum<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

impl<Types: NodeType> PrunerConfig for FileSystemStorage<Types>

where Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

fn set_pruning_config(&mut self, _cfg: PrunerCfg)

fn get_pruning_config(&self) -> Option<PrunerCfg>

impl<Types: NodeType> VersionedDataSource for FileSystemStorage<Types>

where Header<Types>: QueryableHeader<Types>, Payload<Types>: QueryablePayload<Types>,

type Transaction<'a> = Transaction<RwLockWriteGuard<'a, FileSystemStorageInner<Types>>> where Self: 'a

A transaction which can read and modify the data source.

type ReadOnly<'a> = Transaction<RwLockReadGuard<'a, FileSystemStorageInner<Types>>> where Self: 'a

async fn write(&self) -> Result<Self::Transaction<'_>>

Start an atomic transaction on the data source.

async fn read(&self) -> Result<Self::ReadOnly<'_>>

Start a read-only transaction on the data source.