Struct spacetimedb_commitlog::repo::Fs

pub struct Fs { /* private fields */ }

A commitlog repository Repo which stores commits in ordinary files on disk.

Implementations

impl Fs

pub fn new(root: impl Into<PathBuf>) -> Self

Create a commitlog repository which stores segments in the directory root.

root must name an extant, accessible, writeable directory.

pub fn segment_path(&self, offset: u64) -> PathBuf

Get the filename for a segment starting with offset within this repository.

pub fn size_on_disk(&self) -> Result<u64>

Determine the size on disk as the sum of the sizes of all segments.

Note that the actively written-to segment (if any) is included.

Trait Implementations

impl Clone for Fs

fn clone(&self) -> Fs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fs

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

Formats the value using the given formatter.

impl Repo for Fs

type Segment = File

The type of log segments managed by this repo, which must behave like a file.

fn create_segment(&self, offset: u64) -> Result<Self::Segment>

Create a new segment with the minimum transaction offset offset.

fn open_segment(&self, offset: u64) -> Result<Self::Segment>

Open an existing segment at the minimum transaction offset offset.

fn remove_segment(&self, offset: u64) -> Result<()>

Remove the segment at the minimum transaction offset offset.

fn existing_offsets(&self) -> Result<Vec<u64>>

Traverse all segments in this repository and return list of their offsets, sorted in ascending order.