VirtioFsWriter

Struct VirtioFsWriter 

Source
pub struct VirtioFsWriter<'a, S = ()> { /* private fields */ }
Expand description

Provide high-level interface over the sequence of memory regions defined by writable descriptors in the Virtio descriptor chain.

Note that virtio spec requires driver to place any device-writable descriptors after any device-readable descriptors (2.6.4.2 in Virtio Spec v1.1). Writer will start iterating the descriptors from the first writable one and will assume that all following descriptors are writable.

Implementations§

Source§

impl<'a, S: BitmapSlice> VirtioFsWriter<'a, S>

Source

pub async fn async_write(&mut self, data: &[u8]) -> Result<usize>

Write data from a buffer into this writer in asynchronous mode.

Source

pub async fn async_write2(&mut self, data: &[u8], data2: &[u8]) -> Result<usize>

Write data from two buffers into this writer in asynchronous mode.

Source

pub async fn async_write3( &mut self, data: &[u8], data2: &[u8], data3: &[u8], ) -> Result<usize>

Write data from three buffers into this writer in asynchronous mode.

Source

pub async fn async_write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer in asynchronous mode.

Source

pub async fn async_write_from_at<F: AsyncFileReadWriteVolatile>( &mut self, src: &F, count: usize, off: u64, ) -> Result<usize>

Writes data to the descriptor chain buffer from a File at offset off. Returns the number of bytes written to the descriptor chain buffer.

Source

pub async fn async_commit( &mut self, other: Option<&Writer<'a, S>>, ) -> Result<usize>

Commit all internal buffers of self and others We need this because the lifetime of others is usually shorter than self.

Source§

impl<'a> VirtioFsWriter<'a>

Source

pub fn new<M>( mem: &'a M::Target, desc_chain: DescriptorChain<M>, ) -> Result<VirtioFsWriter<'a, MS<'a, M::Target>>>
where M: Deref, M::Target: GuestMemory + Sized,

Construct a new Writer wrapper over desc_chain.

Source§

impl<'a, S: BitmapSlice> VirtioFsWriter<'a, S>

Source

pub fn write_obj<T: ByteValued>(&mut self, val: T) -> Result<()>

Write an object to the descriptor chain buffer.

Source

pub fn write_from<F: FileReadWriteVolatile>( &mut self, src: F, count: usize, ) -> Result<usize>

Write data to the descriptor chain buffer from a file descriptor.

Return the number of bytes written to the descriptor chain buffer.

Source

pub fn write_from_at<F: FileReadWriteVolatile>( &mut self, src: F, count: usize, off: u64, ) -> Result<usize>

Write data to the descriptor chain buffer from a File at offset off.

Return the number of bytes written to the descriptor chain buffer.

Source

pub fn write_all_from<F: FileReadWriteVolatile>( &mut self, src: F, count: usize, ) -> Result<()>

Write all data to the descriptor chain buffer from a file descriptor.

Source

pub fn available_bytes(&self) -> usize

Return number of bytes available for writing.

May return an error if the combined lengths of all the buffers in the DescriptorChain would cause an overflow.

Source

pub fn bytes_written(&self) -> usize

Return number of bytes already written to the descriptor chain buffer.

Source

pub fn split_at(&mut self, offset: usize) -> Result<Self>

Split this Writer into two at the given offset in the DescriptorChain buffer. After the split, self will be able to write up to offset bytes while the returned Writer can write up to available_bytes() - offset bytes. Returns an error if offset > self.available_bytes().

Source

pub fn commit(&mut self, _other: Option<&Writer<'a, S>>) -> Result<usize>

Commit all internal buffers of self and others

This is provided just to be compatible with fusedev

Trait Implementations§

Source§

impl<'a, S: Clone> Clone for VirtioFsWriter<'a, S>

Source§

fn clone(&self) -> VirtioFsWriter<'a, S>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, S: BitmapSlice> From<VirtioFsWriter<'a, S>> for Writer<'a, S>

Source§

fn from(w: VirtioFsWriter<'a, S>) -> Self

Converts to this type from the input type.
Source§

impl<S: BitmapSlice> Write for VirtioFsWriter<'_, S>

Source§

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

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

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

Like write, except that it writes from a slice of buffers. Read more
Source§

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
Source§

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. Read more
1.0.0 · Source§

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

Attempts to write an entire buffer into this writer. Read more
Source§

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. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

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

Auto Trait Implementations§

§

impl<'a, S> Freeze for VirtioFsWriter<'a, S>

§

impl<'a, S> RefUnwindSafe for VirtioFsWriter<'a, S>
where S: RefUnwindSafe,

§

impl<'a, S = ()> !Send for VirtioFsWriter<'a, S>

§

impl<'a, S = ()> !Sync for VirtioFsWriter<'a, S>

§

impl<'a, S> Unpin for VirtioFsWriter<'a, S>
where S: Unpin,

§

impl<'a, S> UnwindSafe for VirtioFsWriter<'a, S>
where S: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.