Struct body_image_futio::UniBodyBuf

pub struct UniBodyBuf { /* fields omitted */ }

Provides zero-copy read access to both Bytes and memory mapped regions (MemMapBuf). Implements bytes::Buf (mmap feature only).

Trait Implementations

impl AsRef<[u8]> for UniBodyBuf

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

Performs the conversion.

impl Buf for UniBodyBuf

fn remaining(&self) -> usize

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

fn bytes(&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, count: usize)

Advance the internal cursor of the Buf

fn bytes_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 to_bytes(&mut self) -> Bytes

Consumes remaining bytes inside self and returns new instance of Bytes

impl Debug for UniBodyBuf

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

Formats the value using the given formatter.

impl Deref for UniBodyBuf

type Target = [u8]

The resulting type after dereferencing.

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

Dereferences the value.

impl From<Bytes> for UniBodyBuf

fn from(b: Bytes) -> Self

Performs the conversion.

impl InputBuf for UniBodyBuf

impl Into<Bytes> for UniBodyBuf

fn into(self) -> Bytes

Convert from UniBodyBuf to Bytes. This is a costly memory copy only in the case of MemMap (mmap feature) to Bytes. This case is logged and should be rare using normal configuration and high-level API. For example, it could occur when a Stream of UniBodyBuf over an MemMap BodyImage is forwarded to a Sink configured with a larger Tunables::max_body_ram. With the same maximums used to produce the original image and output sink, this should not occur, as no conversion is required when writing to FsWrite state.

impl OutputBuf for UniBodyBuf

fn from_mmap(mmap: MemHandle<Mmap>) -> Result<Self, Error>

Convert from a MemHandle<Mmap>