Struct Commit 

pub struct Commit {
    pub vid: VolumeId,
    pub lsn: LSN,
    pub page_count: PageCount,
    pub commit_hash: Option<CommitHash>,
    pub segment_idx: Option<SegmentIdx>,
    pub checkpointed_at: Option<SystemTime>,
}

Commits are stored at {prefix}/{vid}/log/{lsn}. A commit may not include a SegmentRef if only the Volume’s page count has changed. This happens when the Volume is extended or truncated without additional writes. Commits are immutable.

Fields

vid: VolumeId

The Volume’s ID.

lsn: LSN

The LSN of the Commit.

page_count: PageCount

The Volume’s PageCount as of this Commit.

commit_hash: Option<CommitHash>

An optional CommitHash for this Commit. Always present on Remote Volume commits. May be omitted on Local commits.

segment_idx: Option<SegmentIdx>

If this Commit contains any pages, segment_idx records details on the relevant Segment.

checkpointed_at: Option<SystemTime>

If this commit is a checkpoint, this timestamp is set and records the time the commit was made a checkpoint

Implementations

impl Commit

pub fn new(vid: VolumeId, lsn: LSN, page_count: PageCount) -> Self

Creates a new Commit for the given snapshot info

pub fn with_vid(self, vid: VolumeId) -> Self

pub fn with_lsn(self, lsn: LSN) -> Self

pub fn with_commit_hash(self, commit_hash: Option<CommitHash>) -> Self

pub fn with_segment_idx(self, segment_idx: Option<SegmentIdx>) -> Self

Sets the segment index for this commit.

pub fn with_checkpointed_at(self, checkpointed_at: Option<SystemTime>) -> Self

Sets the checkpointed timestamp for this commit.

pub fn vid(&self) -> &VolumeId

pub fn lsn(&self) -> LSN

pub fn vref(&self) -> VolumeRef

pub fn page_count(&self) -> PageCount

pub fn commit_hash(&self) -> Option<&CommitHash>

pub fn segment_idx(&self) -> Option<&SegmentIdx>

pub fn checkpointed_at(&self) -> Option<&SystemTime>

pub fn is_checkpoint(&self) -> bool

Trait Implementations

impl Clone for Commit

fn clone(&self) -> Commit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Commit

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

Formats the value using the given formatter.

impl Default for Commit

fn default() -> Commit

Returns the “default value” for a type.

impl EmptyState<(), Commit> for ()

where (): EmptyState<general, LSN> + EmptyState<general, Option<CommitHash>> + EmptyState<general, Option<SegmentIdx>> + EmptyState<general, Option<SystemTime>> + EmptyState<general, PageCount> + EmptyState<general, VolumeId> + Encoder<general, LSN> + Encoder<general, Option<CommitHash>> + Encoder<general, Option<SegmentIdx>> + Encoder<general, Option<SystemTime>> + Encoder<general, PageCount> + Encoder<general, VolumeId>,

fn is_empty(val: &__Self) -> bool

Returns true iff this instance is in the empty state.

fn clear(val: &mut __Self)

fn empty() -> T

Produces the empty state for this type.

impl ForOverwrite<(), Commit> for ()

where (): EmptyState<general, LSN> + EmptyState<general, Option<CommitHash>> + EmptyState<general, Option<SegmentIdx>> + EmptyState<general, Option<SystemTime>> + EmptyState<general, PageCount> + EmptyState<general, VolumeId> + Encoder<general, LSN> + Encoder<general, Option<CommitHash>> + Encoder<general, Option<SegmentIdx>> + Encoder<general, Option<SystemTime>> + Encoder<general, PageCount> + Encoder<general, VolumeId>,

fn for_overwrite() -> __Self

Produces a new Self value to be overwritten.

impl PartialEq for Commit

fn eq(&self, other: &Commit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RawMessage for __Self

where (): EmptyState<general, LSN> + EmptyState<general, Option<CommitHash>> + EmptyState<general, Option<SegmentIdx>> + EmptyState<general, Option<SystemTime>> + EmptyState<general, PageCount> + EmptyState<general, VolumeId> + Encoder<general, LSN> + Encoder<general, Option<CommitHash>> + Encoder<general, Option<SegmentIdx>> + Encoder<general, Option<SystemTime>> + Encoder<general, PageCount> + Encoder<general, VolumeId>,

const __ASSERTIONS: ()

fn empty() -> Self

Returns an initialized message in an empty state.

fn is_empty(&self) -> bool

Returns whether the message is currently empty.

fn clear(&mut self)

Resets the message to an empty state.

fn raw_encode<__B>(&self, buf: &mut __B)

where __B: BufMut + ?Sized,

Encodes the message to a buffer.

fn raw_prepend<__B>(&self, buf: &mut __B)

where __B: ReverseBuf + ?Sized,

Prepends the message to a prepend buffer.

fn raw_encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

impl<'__a> RawMessageBorrowDecoder<'__a> for __Self

where (): BorrowDecoder<'__a, general, LSN> + BorrowDecoder<'__a, general, Option<CommitHash>> + BorrowDecoder<'__a, general, Option<SegmentIdx>> + BorrowDecoder<'__a, general, Option<SystemTime>> + BorrowDecoder<'__a, general, PageCount> + BorrowDecoder<'__a, general, VolumeId> + EmptyState<general, LSN> + EmptyState<general, Option<CommitHash>> + EmptyState<general, Option<SegmentIdx>> + EmptyState<general, Option<SystemTime>> + EmptyState<general, PageCount> + EmptyState<general, VolumeId>,

fn raw_borrow_decode_field( &mut self, tag: u32, wire_type: WireType, duplicated: bool, buf: Capped<'_, &'__a [u8]>, ctx: DecodeContext, ) -> Result<(), DecodeError>

Decodes a field from a buffer into self from a borrowed slice.

impl RawMessageDecoder for __Self

where (): Decoder<general, LSN> + Decoder<general, Option<CommitHash>> + Decoder<general, Option<SegmentIdx>> + Decoder<general, Option<SystemTime>> + Decoder<general, PageCount> + Decoder<general, VolumeId> + EmptyState<general, LSN> + EmptyState<general, Option<CommitHash>> + EmptyState<general, Option<SegmentIdx>> + EmptyState<general, Option<SystemTime>> + EmptyState<general, PageCount> + EmptyState<general, VolumeId>,

fn raw_decode_field<__B>( &mut self, tag: u32, wire_type: WireType, duplicated: bool, buf: Capped<'_, __B>, ctx: DecodeContext, ) -> Result<(), DecodeError>

where __B: Buf + ?Sized,

Decodes a field from a buffer into self.

impl Eq for Commit

impl StructuralPartialEq for Commit