Struct CurrentSegment

pub struct CurrentSegment<F> { /* private fields */ }

Implementations

impl<F> CurrentSegment<F>

pub fn create( segment_file: F, path: PathBuf, start_frame_no: NonZeroU64, db_size: u32, tail: Arc<SegmentList<SealedSegment<F>>>, salt: u32, log_id: Uuid, ) -> Result<Self>

where F: FileExt,

Create a new segment from the given path and metadata. The file pointed to by path must not exist.

pub fn log_id(&self) -> Uuid

pub fn is_empty(&self) -> bool

pub fn with_header<R>(&self, f: impl FnOnce(&SegmentHeader) -> R) -> R

pub fn last_committed(&self) -> u64

pub fn next_frame_no(&self) -> NonZeroU64

pub fn count_committed(&self) -> usize

pub fn db_size(&self) -> u32

pub fn current_checksum(&self) -> u32

pub async fn inject_frames( &self, frames: Vec<Box<Frame>>, commit_data: Option<(u32, u64)>, tx: &mut TxGuardOwned<F>, ) -> Result<Vec<Box<Frame>>>

where F: FileExt,

insert a bunch of frames in the Wal. The frames needn’t be ordered, therefore, on commit the last frame no needs to be passed alongside the new size_after.

pub fn insert_pages<'a>( &self, pages: impl Iterator<Item = (u32, &'a [u8])>, size_after: Option<u32>, tx: &mut TxGuardShared<'_, F>, ) -> Result<Option<u64>>

where F: FileExt,

pub fn find_frame(&self, page_no: u32, tx: &Transaction<F>) -> Option<u32>

return the offset of the frame for page_no, with frame_no no larger that max_frame_no, if it exists

pub fn read_page_offset(&self, offset: u32, buf: &mut [u8]) -> Result<()>

where F: FileExt,

reads the page conainted in frame at offset into buf

pub fn frame_header_at(&self, offset: u32) -> Result<FrameHeader>

where F: FileExt,

pub fn seal(&self, now: DateTime<Utc>) -> Result<Option<SealedSegment<F>>>

where F: FileExt,

It is expected that sealing is performed under a write lock

pub fn last_committed_frame_no(&self) -> u64

pub fn inc_reader_count(&self)

pub fn dec_reader_count(&self) -> bool

return true if the reader count is 0

pub fn read_locks(&self) -> &AtomicU64

pub fn is_sealed(&self) -> bool

pub fn tail(&self) -> &Arc<SegmentList<SealedSegment<F>>>

Trait Implementations

impl<F> Drop for CurrentSegment<F>

fn drop(&mut self)

Executes the destructor for this type.