Struct RingBuffer 

pub struct RingBuffer { /* private fields */ }

The content is kept in memory when written, when offset rewinds, new content will overwrite old content, So that memory consumption is limited to buf_size. Once deadlock encountered and process hangs, no more message will be written, you can safely dump the content to disk.

Example:

use ring_file::RingBuffer;
use std::io::Write;
let mut file = RingBuffer::new(512*1024*1024);
file.write_all(b"log message").expect("write ok");
file.dump("/tmp/ringfile.store").expect("dump ok");

Implementations

impl RingBuffer

pub fn new(buf_size: i32) -> Self

Allocate a whole buffer specified by buf_size, size can not exceed 2GB.

pub fn dump<P: AsRef<Path>>(&self, file_path: P) -> Result<()>

Will create a truncated file and write all data from mem to disk.

Trait Implementations

impl Write for RingBuffer

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write will abort when reaching the boundary of buffer, rewind the offset to 0 and return the bytes written. You can use Write::write_all() provided by the trait to cover the rewinding logic.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.