Struct commitlog::CommitLog

pub struct CommitLog { /* fields omitted */ }

The commit log is an append-only sequence of messages.

Implementations

impl CommitLog

pub fn new(opts: LogOptions) -> Result<CommitLog>

Creates or opens an existing commit log.

pub fn append_msg<B: AsRef<[u8]>>(
    &mut self,
    payload: B
) -> Result<Offset, AppendError>

Appends a single message to the log, returning the offset appended.

pub fn append<T>(&mut self, buf: &mut T) -> Result<OffsetRange, AppendError> where
    T: MessageSetMut, 

Appends log entrites to the commit log, returning the offsets appended.

pub fn append_with_offsets<T>(
    &mut self,
    buf: &T
) -> Result<OffsetRange, AppendError> where
    T: MessageSet, 

Appends log entrites to the commit log, returning the offsets appended.

The offsets are expected to already be set within the buffer.

pub fn last_offset(&self) -> Option<Offset>

Gets the last written offset.

pub fn next_offset(&self) -> Offset

Gets the latest offset

pub fn read(
    &self,
    start: Offset,
    limit: ReadLimit
) -> Result<MessageBuf, ReadError>

Reads a portion of the log, starting with the start offset, inclusive, up to the limit.

pub fn reader<R: LogSliceReader>(
    &self,
    reader: &mut R,
    start: Offset,
    limit: ReadLimit
) -> Result<Option<R::Result>, ReadError>

Reads a portion of the log, starting with the start offset, inclusive, up to the limit via the reader.

pub fn truncate(&mut self, offset: Offset) -> Result<()>

Truncates a file after the offset supplied. The resulting log will contain entries up to the offset.

pub fn flush(&mut self) -> Result<()>

Forces a flush of the log.