Struct BufferImpl 

pub struct BufferImpl<'a, H: Borrow<A>, A: ?Sized + BufferAllocator> { /* private fields */ }

Implementations

impl<'a, H: Borrow<A>, A: ?Sized + BufferAllocator> BufferImpl<'a, H, A>

pub fn as_ref(&self) -> BufferRef<'_>

Takes a read-only reference to this buffer.

pub fn subslice<R: SliceRange>(&self, range: R) -> BufferRef<'_>

Takes a read-only reference to this buffer over range (which must be within the size of the buffer).

pub fn as_mut(&mut self) -> MutableBufferRef<'_>

Takes a read-write reference to this buffer.

pub fn writer(&mut self) -> Writer<'_>

Returns an io::Write adapter for this buffer.

pub fn subslice_mut<R: SliceRange>(&mut self, range: R) -> MutableBufferRef<'_>

Takes a read-write reference to this buffer over range (which must be within the size of the buffer).

pub fn len(&self) -> usize

Returns the buffer’s capacity.

pub fn paddrs(&self) -> Option<&[zx_paddr_t]>

Returns the physical addresses for DMA if this buffer is pinned by its allocator.

pub fn contiguity(&self) -> Option<u64>

Returns the contiguity used when pinning this buffer, if pinned by its allocator.

pub fn vmo(&self) -> Option<Arc<Vmo>>

Returns the underlying VMO if the buffer is untrusted and backed by a VMO.

Returns None if the buffer is trusted.

pub fn try_as_slice(&self) -> Option<&[u8]>

Returns a reference to the underlying data if the buffer is trusted. Returns None if the buffer is untrusted (shared with the driver).

pub fn try_as_mut_slice(&mut self) -> Option<&mut [u8]>

Returns a mutable reference to the underlying data if the buffer is trusted. Returns None if the buffer is untrusted (shared with the driver).

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

Copies the contents of this buffer into dest.

Panics

Panics if dest.len() != self.len().

pub fn copy_from_slice(&mut self, src: &[u8])

Copies the contents of src into this buffer.

Panics

Panics if src.len() != self.len().

pub fn copy_from_buffer(&mut self, src: BufferRef<'_>)

Copies the contents of src buffer into this buffer.

Panics

Panics if src.len() != self.len().

pub fn fill(&mut self, val: u8)

Fills the buffer with val.

pub fn range(&self) -> Range<usize>

Returns the range in the underlying BufferSource that this buffer covers.

pub fn allocator(&self) -> &A

Returns a reference to the allocator.

pub fn to_vec(&self) -> Vec<u8>

Returns the buffer’s contents as a Vec.

pub fn append_to(&self, vec: &mut Vec<u8>)

Appends the buffer’s contents to vec.

pub fn as_ptr(&self) -> *const u8

Returns a raw pointer to the buffer’s contents.

pub fn as_mut_ptr(&mut self) -> *mut u8

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

pub fn as_ptr_slice(&self) -> PtrByteSlice<'_>

Returns a read-only pointer slice over the buffer.

pub fn as_mut_ptr_slice(&mut self) -> MutPtrByteSlice<'_>

Returns a mutable pointer slice over the buffer.

impl BufferImpl<'static, Arc<dyn BufferAllocator>, dyn BufferAllocator>

pub fn split<R>( self, f: impl FnOnce(&mut SplittableBuffer) -> Result<R, Error>, on_complete: impl FnOnce(Result<OwnedBuffer, Error>) + Send + 'static, ) -> Result<R, Error>

Splits the buffer into one or more child OwnedBuffers via f.

When all child OwnedBuffers and SubHandles drop, the merged parent buffer is automatically delivered to on_complete(Ok(parent_buffer)). If an error occurs via f or during sub-operation execution, on_complete(Err(e)) is delivered.

Trait Implementations

impl<'a, H: Debug + Borrow<A>, A: Debug + ?Sized + BufferAllocator> Debug for BufferImpl<'a, H, A>

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

Formats the value using the given formatter.

impl<'a, H: Borrow<A>, A: ?Sized + BufferAllocator> Drop for BufferImpl<'a, H, A>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.