Struct fmmap::MmapFileWriter

pub struct MmapFileWriter<'a> { /* private fields */ }

MmapFileWriter helps read or write data from mmap file like a normal file.

Notes

If you use a writer to write data to mmap, there is no guarantee all data will be durably stored. So you need to call flush/flush_range/flush_async/flush_async_range in MmapFileMutExt to guarantee all data will be durably stored.

Implementations

impl<'a> MmapFileWriter<'a>

pub fn offset(&self) -> usize

Available on crate feature sync only.

Returns the start offset(related to the mmap) of the writer

pub fn len(&self) -> usize

Available on crate feature sync only.

Returns the length of the writer

Trait Implementations

impl<'a> Buf for MmapFileWriter<'a>

Available on crate feature sync only.

fn remaining(&self) -> usize

Returns the number of bytes between the current position and the end of the buffer.

fn chunk(&self) -> &[u8]

Returns a slice starting at the current position and of length between 0 and Buf::remaining(). Note that this can return shorter slice (this allows non-continuous internal representation).

fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buf

fn chunks_vectored(&'a self, dst: &mut [IoSlice<'a>]) -> usize

Fills dst with potentially multiple slices starting at self’s current position.

fn has_remaining(&self) -> bool

Returns true if there are any more bytes to consume

fn copy_to_slice(&mut self, dst: &mut [u8])

Copies bytes from self into dst.

fn get_u8(&mut self) -> u8

Gets an unsigned 8 bit integer from self.

fn get_i8(&mut self) -> i8

Gets a signed 8 bit integer from self.

fn get_u16(&mut self) -> u16

Gets an unsigned 16 bit integer from self in big-endian byte order.

fn get_u16_le(&mut self) -> u16

Gets an unsigned 16 bit integer from self in little-endian byte order.

fn get_i16(&mut self) -> i16

Gets a signed 16 bit integer from self in big-endian byte order.

fn get_i16_le(&mut self) -> i16

Gets a signed 16 bit integer from self in little-endian byte order.

fn get_u32(&mut self) -> u32

Gets an unsigned 32 bit integer from self in the big-endian byte order.

fn get_u32_le(&mut self) -> u32

Gets an unsigned 32 bit integer from self in the little-endian byte order.

fn get_i32(&mut self) -> i32

Gets a signed 32 bit integer from self in big-endian byte order.

fn get_i32_le(&mut self) -> i32

Gets a signed 32 bit integer from self in little-endian byte order.

fn get_u64(&mut self) -> u64

Gets an unsigned 64 bit integer from self in big-endian byte order.

fn get_u64_le(&mut self) -> u64

Gets an unsigned 64 bit integer from self in little-endian byte order.

fn get_i64(&mut self) -> i64

Gets a signed 64 bit integer from self in big-endian byte order.

fn get_i64_le(&mut self) -> i64

Gets a signed 64 bit integer from self in little-endian byte order.

fn get_u128(&mut self) -> u128

Gets an unsigned 128 bit integer from self in big-endian byte order.

fn get_u128_le(&mut self) -> u128

Gets an unsigned 128 bit integer from self in little-endian byte order.

fn get_i128(&mut self) -> i128

Gets a signed 128 bit integer from self in big-endian byte order.

fn get_i128_le(&mut self) -> i128

Gets a signed 128 bit integer from self in little-endian byte order.

fn get_uint(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from self in big-endian byte order.

fn get_uint_le(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from self in little-endian byte order.

fn get_int(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from self in big-endian byte order.

fn get_int_le(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from self in little-endian byte order.

fn get_f32(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from self in big-endian byte order.

fn get_f32_le(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from self in little-endian byte order.

fn get_f64(&mut self) -> f64

Gets an IEEE754 double-precision (8 bytes) floating point number from self in big-endian byte order.

fn get_f64_le(&mut self) -> f64

Gets an IEEE754 double-precision (8 bytes) floating point number from self in little-endian byte order.

fn copy_to_bytes(&mut self, len: usize) -> Bytes

Consumes len bytes inside self and returns new instance of Bytes with this data.

fn take(self, limit: usize) -> Take<Self>

Creates an adaptor which will read at most limit bytes from self.

fn chain<U>(self, next: U) -> Chain<Self, U> where
    U: Buf, 

Creates an adaptor which will chain this buffer with another.

fn reader(self) -> Reader<Self>

Creates an adaptor which implements the Read trait for self.

impl<'a> BufRead for MmapFileWriter<'a>

Available on crate feature sync only.

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Check if the underlying Read has any data left to be read.

fn read_until(
    &mut self,
    byte: u8,
    buf: &mut Vec<u8, Global>
) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. You do not need to clear the buffer before appending.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl Debug for MmapFileWriter<'_>

Available on crate feature sync only.

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

Formats the value using the given formatter.

impl<'a> MmapFileWriterExt for MmapFileWriter<'a>

Available on crate feature sync only.

fn write_i8(&mut self, n: i8) -> Result<()>

Writes a signed 8 bit integer to the underlying writer. Note that since this writes a single byte, no byte order conversions are used. It is included for completeness.

fn write_i16(&mut self, n: i16) -> Result<()>

Writes a signed 16 bit integer(big endian) to the underlying writer.

fn write_i16_le(&mut self, n: i16) -> Result<()>

Writes a signed 16 bit integer(little endian) to the underlying writer.

fn write_i32(&mut self, n: i32) -> Result<()>

Writes a signed 32 bit integer(big endian) to the underlying writer.

fn write_i32_le(&mut self, n: i32) -> Result<()>

Writes a signed 32 bit integer(little endian) to the underlying writer.

fn write_i64(&mut self, n: i64) -> Result<()>

Writes a signed 64 bit integer(big endian) to the underlying writer.

fn write_i64_le(&mut self, n: i64) -> Result<()>

Writes a signed 64 bit integer(little endian) to the underlying writer.

fn write_isize(&mut self, n: isize) -> Result<()>

Writes a signed integer(big endian) to the underlying writer.

fn write_isize_le(&mut self, n: isize) -> Result<()>

Writes a signed integer(little endian) to the underlying writer.

fn write_i128(&mut self, n: i128) -> Result<()>

Writes a signed 128 bit integer(big endian) to the underlying writer.

fn write_i128_le(&mut self, n: i128) -> Result<()>

Writes a signed 128 bit integer(little endian) to the underlying writer.

fn write_u8(&mut self, n: u8) -> Result<()>

Writes an unsigned 8 bit integer to the underlying writer. Note that since this writes a single byte, no byte order conversions are used. It is included for completeness.

fn write_u16(&mut self, n: u16) -> Result<()>

Writes an unsigned 16 bit integer(big endian) to the underlying writer.

fn write_u16_le(&mut self, n: u16) -> Result<()>

Writes an unsigned 16 bit integer(little endian) to the underlying writer.

fn write_u32(&mut self, n: u32) -> Result<()>

Writes an unsigned 32 bit integer(big endian) to the underlying writer.

fn write_u32_le(&mut self, n: u32) -> Result<()>

Writes an unsigned 32 bit integer(little endian) to the underlying writer.

fn write_u64(&mut self, n: u64) -> Result<()>

Writes an unsigned 64 bit integer(big endian) to the underlying writer.

fn write_u64_le(&mut self, n: u64) -> Result<()>

Writes an unsigned 64 bit integer(little endian) to the underlying writer.

fn write_usize(&mut self, n: usize) -> Result<()>

Writes an unsigned integer(big endian) to the underlying writer.

fn write_usize_le(&mut self, n: usize) -> Result<()>

Writes an unsigned integer(little endian) to the underlying writer.

fn write_u128(&mut self, n: u128) -> Result<()>

Writes an unsigned 128 bit integer(big endian) to the underlying writer.

fn write_u128_le(&mut self, n: u128) -> Result<()>

Writes an unsigned 128 bit integer(little endian) to the underlying writer.

fn write_f32(&mut self, n: f32) -> Result<()>

Writes a IEEE754 single-precision (4 bytes, big endian) floating point number to the underlying writer.

fn write_f32_le(&mut self, n: f32) -> Result<()>

Writes a IEEE754 single-precision (4 bytes, little endian) floating point number to the underlying writer.

fn write_f64(&mut self, n: f64) -> Result<()>

Writes a IEEE754 single-precision (8 bytes, big endian) floating point number to the underlying writer

fn write_f64_le(&mut self, n: f64) -> Result<()>

Writes a IEEE754 single-precision (8 bytes, little endian) floating point number to the underlying writer

impl<'a> Read for MmapFileWriter<'a>

Available on crate feature sync only.

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill buf.

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

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it.

impl<'a> Seek for MmapFileWriter<'a>

Available on crate feature sync only.

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

impl<'a> Write for MmapFileWriter<'a>

Available on crate feature sync only.

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

Write a buffer into this writer, returning how many bytes were written.

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

Flush 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, fmt: Arguments<'_>) -> Result<(), Error>

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

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

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