Struct fuse_backend_rs::common::file_buf::FileVolatileBuf

pub struct FileVolatileBuf { /* private fields */ }

An adapter structure to support io-uring based asynchronous IO.

The tokio-uring framework needs to take ownership of data buffers during asynchronous IO operations. The FileVolatileBuf converts a referenced buffer to a buffer compatible with the tokio-uring APIs.

Safety

The buffer is borrowed without a lifetime parameter, so the caller must ensure that the FileVolatileBuf object doesn’t out-live the borrowed buffer. And during the lifetime of the FileVolatileBuf object, the referenced buffer must be stable.

Implementations

impl FileVolatileBuf

pub unsafe fn new(buf: &mut [u8]) -> Self

Create a FileVolatileBuf object from a mutable slice, eliding the lifetime associated with the slice.

Safety

The caller needs to guarantee that the returned FileVolatileBuf object doesn’t out-live the referenced buffer. The caller must also guarantee that all other users of the given chunk of memory are using volatile accesses.

pub unsafe fn new_with_data(buf: &mut [u8], size: usize) -> Self

Create a FileVolatileBuf object containing size bytes of initialized data from a mutable slice, eliding the lifetime associated with the slice.

Safety

The caller needs to guarantee that the returned FileVolatileBuf object doesn’t out-live the referenced buffer. The caller must also guarantee that all other users of the given chunk of memory are using volatile accesses.

Panic

Panic if size is bigger than buf.len().

pub unsafe fn from_raw_ptr(addr: *mut u8, size: usize, cap: usize) -> Self

Create a FileVolatileBuf object from a raw pointer.

Safety

The caller needs to guarantee that the returned FileVolatileBuf object doesn’t out-live the referenced buffer. The caller must also guarantee that all other users of the given chunk of memory are using volatile accesses.

Panic

Panic if size is bigger than cap.

pub fn io_slice(&self) -> IoSlice<'_>

Generate an IoSlice object to read data from the buffer.

pub fn io_slice_mut(&self) -> IoSliceMut<'_>

Generate an IoSliceMut object to write data into the buffer.

pub fn cap(&self) -> usize

Get capacity of the buffer.

pub fn is_empty(&self) -> bool

Check whether the buffer is empty.

pub fn len(&self) -> usize

Get size of initialized data in the buffer.

pub unsafe fn set_size(&mut self, size: usize)

Set size of initialized data in the buffer.

Safety

Caller needs to ensure size is less than or equal to cap.

Trait Implementations

impl Clone for FileVolatileBuf

fn clone(&self) -> FileVolatileBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileVolatileBuf

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

Formats the value using the given formatter.

impl IoBuf for FileVolatileBuf

fn stable_ptr(&self) -> *const u8

Returns a raw pointer to the vector’s buffer.

fn bytes_init(&self) -> usize

Number of initialized bytes.

fn bytes_total(&self) -> usize

Total size of the buffer, including uninitialized memory, if any.

fn slice(self, range: impl RangeBounds<usize>) -> Slice<Self>where
    Self: Sized,

Returns a view of the buffer with the specified range.

impl IoBufMut for FileVolatileBuf

fn stable_mut_ptr(&mut self) -> *mut u8

Returns a raw mutable pointer to the vector’s buffer.

unsafe fn set_init(&mut self, pos: usize)

Updates the number of initialized bytes.

impl Copy for FileVolatileBuf