Struct BytesView 

pub struct BytesView { /* private fields */ }

A view over a sequence of immutable bytes.

Only the contents are immutable - the view itself can be mutated in terms of progressively marking the byte sequence as consumed until the view becomes empty.

Creating a BytesView

Instances can be created in different ways:

• Use a BytesBuf to build the byte sequence piece by piece, consuming the buffered data as a new BytesView when finished.
• Clone an existing BytesView with clone().
• Take a range of bytes from an existing BytesView via range().
• Combine multiple BytesView instances into one via from_views(), concat() or append().
• Copy data from a &[u8] using copied_from_slice().

Some of these methods may require you to first obtain access to a memory provider.

Memory layout

A byte sequence represented by bytesbuf types may consist of any number of separate byte slices, each of which contains one or more bytes of data.

There is no upper or lower bound on the length of each slice of bytes. At one extreme, a byte sequence may be entirely represented by a single slice of bytes. At the opposite extreme, it is legal for each byte to be represented by a separate non-consecutive slice.

Examples of legal memory layouts for the byte sequence b'Hello':

• ['H', 'e', 'l', 'l', 'o']
• ['H', 'e'], ['l', 'l', 'o']
• ['H'], ['e'], ['l'], ['l'], ['o']

Code using these APIs is required to work with any memory layout, as there are no guarantees on which layout will be used for which byte sequences.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"Hello!", &memory);

// Read bytes one at a time until the view is empty.
while !view.is_empty() {
    let byte = view.get_byte();
    println!("Read byte: {byte}");
}

assert!(view.is_empty());

Implementations

impl BytesView

pub fn to_bytes(&self) -> Bytes

Available on crate features bytes-compat only.

Returns a bytes::Bytes that contains the same byte sequence.

Example

use bytes::Buf;
use bytesbuf::BytesView;

let view = BytesView::copied_from_slice(b"\x12\x34\x56\x78", &memory);

let mut bytes = view.to_bytes();

// Consume the data using the bytes crate's Buf trait.
assert_eq!(bytes.get_u16(), 0x1234);
assert_eq!(bytes.get_u16(), 0x5678);
assert!(!bytes.has_remaining());

Performance

This operation is zero-copy if the sequence is backed by a single consecutive slice of memory capacity.

If the sequence is backed by multiple slices of memory capacity, the data will be copied to a new Bytes instance backed by new memory capacity from the Rust global allocator.

You generally want to avoid this conversion in performance-sensitive code.

This conversion always requires a small dynamic memory allocation for metadata, so avoiding conversions is valuable even if zero-copy.

Why is this not .into()?

We do not allow conversion via .into() because the conversion is not guaranteed to be a cheap operation and may involve data copying. The .to_bytes() function must always be explicitly called to make the conversion more obvious and easier to catch in reviews.

impl BytesView

pub const fn new() -> Self

Creates a view over a zero-sized byte sequence.

Use a BytesBuf to create a view over some actual data.

pub fn from_views<I>(views: I) -> Self

where I: IntoIterator<Item = Self>, <I as IntoIterator>::IntoIter: DoubleEndedIterator,

Concatenates a number of existing byte sequences, yielding a combined view.

Example

use bytesbuf::BytesView;

let header = BytesView::copied_from_slice(b"HTTP/1.1 ", &memory);
let status = BytesView::copied_from_slice(b"200 ", &memory);
let message = BytesView::copied_from_slice(b"OK", &memory);

let response_line = BytesView::from_views([header, status, message]);

assert_eq!(response_line.len(), 15);
assert_eq!(response_line, b"HTTP/1.1 200 OK");

Panics

Panics if the resulting view would be larger than usize::MAX bytes.

pub fn copied_from_slice(bytes: &[u8], memory: &impl Memory) -> Self

Creates a BytesView by copying the contents of a &[u8].

Example

use bytesbuf::BytesView;

const CONTENT_TYPE_KEY: &[u8] = b"Content-Type: ";

let header_key = BytesView::copied_from_slice(CONTENT_TYPE_KEY, &tcp_connection.memory());

assert_eq!(header_key.len(), 14);

Reusing without copying

There is intentionally no mechanism in the bytesbuf crate to reference an existing &[u8] without copying the contents, even if it has a 'static lifetime.

The purpose of this limitation is to discourage accidentally involving arbitrary memory in high-performance I/O workflows. For efficient I/O processing, data must be stored in memory configured according to the needs of the consuming I/O endpoint, which is not the case for an arbitrary &'static [u8].

To reuse memory allocations, you need to reuse BytesView instances themselves. See the bb_reuse.rs example in the bytesbuf crate for a detailed example.

pub fn len(&self) -> usize

The number of bytes exposed through the view.

Consuming bytes from the view reduces its length.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"Hello", &memory);
assert_eq!(view.len(), 5);

_ = view.get_byte();
assert_eq!(view.len(), 4);

_ = view.get_num_le::<u16>();
assert_eq!(view.len(), 2);

pub fn is_empty(&self) -> bool

Whether the view is of a zero-sized byte sequence.

pub fn extend_lifetime(&self) -> MemoryGuard

Extends the lifetime of the memory capacity backing this view.

This can be useful when unsafe code is used to reference the contents of a BytesView and it is possible to reach a condition where the BytesView itself no longer exists, even though the contents are referenced (e.g. because the remaining references are in non-Rust code).

pub fn range<R>(&self, range: R) -> Self

where R: RangeBounds<usize>,

Returns a range of the byte sequence.

The bounds logic only considers data currently present in the view. Any data already consumed is not considered part of the view.

Example

use bytesbuf::BytesView;

let view = BytesView::copied_from_slice(b"Hello, world!", &memory);

assert_eq!(view.range(0..5), b"Hello");
assert_eq!(view.range(7..), b"world!");
assert_eq!(view.range(..5), b"Hello");
assert_eq!(view.range(..), b"Hello, world!");

Panics

Panics if the provided range is outside the bounds of the view.

pub fn range_checked<R>(&self, range: R) -> Option<Self>

where R: RangeBounds<usize>,

Returns a range of the byte sequence or None if out of bounds.

The bounds logic only considers data currently present in the view. Any data already consumed is not considered part of the view.

pub fn consume_all_slices<F>(&mut self, f: F)

where F: FnMut(&[u8]),

Executes a function f on each slice, consuming them all.

The slices that make up the view are iterated in order, providing each to f. The view becomes empty after this.

Example

use bytesbuf::BytesView;

// Create a multi-slice view by concatenating independent views.
let mut view = BytesView::from_views([part1, part2, part3]);

view.consume_all_slices(|slice| {
    println!("Slice of {} bytes: {:?}", slice.len(), slice);
});

assert!(view.is_empty());

pub fn first_slice(&self) -> &[u8]

References the first slice of bytes in the byte sequence.

Returns an empty slice if the view is over a zero-sized byte sequence.

Memory layout

A byte sequence represented by bytesbuf types may consist of any number of separate byte slices, each of which contains one or more bytes of data.

There is no upper or lower bound on the length of each slice of bytes. At one extreme, a byte sequence may be entirely represented by a single slice of bytes. At the opposite extreme, it is legal for each byte to be represented by a separate non-consecutive slice.

Examples of legal memory layouts for the byte sequence b'Hello':

• ['H', 'e', 'l', 'l', 'o']
• ['H', 'e'], ['l', 'l', 'o']
• ['H'], ['e'], ['l'], ['l'], ['o']

Code using these APIs is required to work with any memory layout, as there are no guarantees on which layout will be used for which byte sequences.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"0123456789ABCDEF", &memory);

// Read the first 10 bytes without assuming the length of first_slice().
let mut ten_bytes = Vec::with_capacity(10);

while ten_bytes.len() < 10 {
    let slice = view.first_slice();

    let bytes_to_take = slice.len().min(10 - ten_bytes.len());

    ten_bytes.extend_from_slice(&slice[..bytes_to_take]);
    view.advance(bytes_to_take);
}

assert_eq!(ten_bytes, b"0123456789");

pub fn slices(&self) -> BytesViewSlices<'_>

Iterates over all the slices that make up this view, together with their metadata.

Each item is a tuple of (data, meta) where data is a byte slice and meta is the optional metadata of the memory block backing that slice.

Memory layout

A byte sequence represented by bytesbuf types may consist of any number of separate byte slices, each of which contains one or more bytes of data.

There is no upper or lower bound on the length of each slice of bytes. At one extreme, a byte sequence may be entirely represented by a single slice of bytes. At the opposite extreme, it is legal for each byte to be represented by a separate non-consecutive slice.

Examples of legal memory layouts for the byte sequence b'Hello':

• ['H', 'e', 'l', 'l', 'o']
• ['H', 'e'], ['l', 'l', 'o']
• ['H'], ['e'], ['l'], ['l'], ['o']

Code using these APIs is required to work with any memory layout, as there are no guarantees on which layout will be used for which byte sequences.

Example

use bytesbuf::BytesView;

let view = BytesView::from_views([part1, part2]);

for (data, meta) in view.slices() {
    let is_page_aligned = meta.is_some_and(|m| m.is::<PageAlignedMemory>());
    println!(
        "Slice of {} bytes (page-aligned: {is_page_aligned})",
        data.len()
    );
}

See the stand-alone example bb_optimal_path.rs in the bytesbuf crate for a more detailed example of how to make use of the slice metadata.

pub fn first_slice_meta(&self) -> Option<&dyn BlockMeta>

Inspects the metadata of the first_slice().

None if there is no metadata associated with the first slice or if the view is over a zero-sized byte sequence.

Example

use bytesbuf::BytesView;

let view = BytesView::copied_from_slice(b"Hello", &memory);

let is_page_aligned = view
    .first_slice_meta()
    .is_some_and(|meta| meta.is::<PageAlignedMemory>());

println!("First slice is page-aligned: {is_page_aligned}");

See the stand-alone example bb_optimal_path.rs in the bytesbuf crate for a more detailed example of how to make use of the slice metadata.

pub fn advance(&mut self, count: usize)

Removes the first count bytes from the front of the view.

The consumed bytes are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"0123456789ABCDEF", &memory);

// Read the first 10 bytes without assuming the length of first_slice().
let mut ten_bytes = Vec::with_capacity(10);

while ten_bytes.len() < 10 {
    let slice = view.first_slice();

    let bytes_to_take = slice.len().min(10 - ten_bytes.len());

    ten_bytes.extend_from_slice(&slice[..bytes_to_take]);
    view.advance(bytes_to_take);
}

assert_eq!(ten_bytes, b"0123456789");

Panics

Panics if count is greater than the number of bytes remaining.

pub fn append(&mut self, other: Self)

Appends another view to the end of this one.

This is a zero-copy operation, reusing the memory capacity of the other view.

Example

use bytesbuf::BytesView;

let mut greeting = BytesView::copied_from_slice(b"Hello, ", &memory);
let name = BytesView::copied_from_slice(b"world!", &memory);

greeting.append(name);

assert_eq!(greeting, b"Hello, world!");

Panics

Panics if the resulting view would be larger than usize::MAX bytes.

pub fn concat(&self, other: Self) -> Self

Returns a new view that concatenates this view with another.

This is a zero-copy operation, reusing the memory capacity of the other view.

Example

use bytesbuf::BytesView;

let greeting = BytesView::copied_from_slice(b"Hello, ", &memory);
let name = BytesView::copied_from_slice(b"world!", &memory);

let message = greeting.concat(name);

// Original view is unchanged.
assert_eq!(greeting, b"Hello, ");
// New view contains the concatenation.
assert_eq!(message, b"Hello, world!");

Panics

Panics if the resulting view would be larger than usize::MAX bytes.

impl BytesView

pub fn get_byte(&mut self) -> u8

Consumes a u8 from the byte sequence.

The consumed byte is dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"ABC", &memory);

assert_eq!(view.get_byte(), b'A');
assert_eq!(view.get_byte(), b'B');
assert_eq!(view.get_byte(), b'C');
assert!(view.is_empty());

Panics

Panics if the view does not cover enough bytes of data.

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

Transfers bytes into an initialized slice.

The copied bytes are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"Hello, world!", &memory);

let mut buffer = [0u8; 5];
view.copy_to_slice(&mut buffer);

assert_eq!(&buffer, b"Hello");
assert_eq!(view.len(), 8); // ", world!" remains

Panics

Panics if the destination is larger than the view.

pub fn copy_to_uninit_slice(&mut self, dst: &mut [MaybeUninit<u8>])

Transfers bytes into a potentially uninitialized slice.

The copied bytes are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use std::mem::MaybeUninit;

use bytesbuf::BytesView;

let mut view = BytesView::copied_from_slice(b"Hello", &memory);

let mut buffer: [MaybeUninit<u8>; 5] = [const { MaybeUninit::uninit() }; 5];
view.copy_to_uninit_slice(&mut buffer);

// SAFETY: The buffer has been fully initialized by copy_to_uninit_slice.
let buffer: [u8; 5] = unsafe { std::mem::transmute(buffer) };
assert_eq!(&buffer, b"Hello");

Panics

Panics if the destination is larger than the view.

pub fn get_num_le<T: FromBytes>(&mut self) -> T

where T::Bytes: Sized,

Consumes a number of type T in little-endian representation.

The bytes of the T are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

// Little-endian: least significant byte first.
let data: &[u8] = &[
    0x34, 0x12, // u16: 0x1234
    0x78, 0x56, 0x34, 0x12, // u32: 0x12345678
];
let mut view = BytesView::copied_from_slice(data, &memory);

assert_eq!(view.get_num_le::<u16>(), 0x1234);
assert_eq!(view.get_num_le::<u32>(), 0x12345678);
assert!(view.is_empty());

Panics

Panics if the view does not cover enough bytes of data.

pub fn get_num_be<T: FromBytes>(&mut self) -> T

where T::Bytes: Sized,

Consumes a number of type T in big-endian representation.

The bytes of the T are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

// Big-endian: most significant byte first.
let data: &[u8] = &[
    0x12, 0x34, 0x56, 0x78, // u32: 0x12345678
    0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF, // u64: 0x0123456789ABCDEF
];
let mut view = BytesView::copied_from_slice(data, &memory);

assert_eq!(view.get_num_be::<u32>(), 0x12345678);
assert_eq!(view.get_num_be::<u64>(), 0x0123456789ABCDEF);
assert!(view.is_empty());

Panics

Panics if the view does not cover enough bytes of data.

pub fn get_num_ne<T: FromBytes>(&mut self) -> T

where T::Bytes: Sized,

Consumes a number of type T in native-endian representation.

The bytes of the T are dropped from the view, moving any remaining bytes to the front.

If permitted by memory layout considerations and reference counts, the memory capacity backing the dropped bytes is released back to the memory provider.

Example

use bytesbuf::BytesView;

// Native-endian: byte order matches the platform.
let value1: u16 = 0x1234;
let value2: u64 = 0x0123456789ABCDEF;

let mut data = Vec::new();
data.extend_from_slice(&value1.to_ne_bytes());
data.extend_from_slice(&value2.to_ne_bytes());

let mut view = BytesView::copied_from_slice(&data, &memory);

assert_eq!(view.get_num_ne::<u16>(), 0x1234);
assert_eq!(view.get_num_ne::<u64>(), 0x0123456789ABCDEF);
assert!(view.is_empty());

Panics

Panics if the view does not cover enough bytes of data.

Trait Implementations

impl Buf for BytesView

Available on crate features bytes-compat 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 a shorter slice (this allows non-continuous internal representation).

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

Available on crate feature std only.

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

fn advance(&mut self, cnt: usize)

Advance the internal cursor of the Buf

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_u16_ne(&mut self) -> u16

Gets an unsigned 16 bit integer from self in native-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_i16_ne(&mut self) -> i16

Gets a signed 16 bit integer from self in native-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_u32_ne(&mut self) -> u32

Gets an unsigned 32 bit integer from self in native-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_i32_ne(&mut self) -> i32

Gets a signed 32 bit integer from self in native-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_u64_ne(&mut self) -> u64

Gets an unsigned 64 bit integer from self in native-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_i64_ne(&mut self) -> i64

Gets a signed 64 bit integer from self in native-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_u128_ne(&mut self) -> u128

Gets an unsigned 128 bit integer from self in native-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_i128_ne(&mut self) -> i128

Gets a signed 128 bit integer from self in native-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_uint_ne(&mut self, nbytes: usize) -> u64

Gets an unsigned n-byte integer from self in native-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_int_ne(&mut self, nbytes: usize) -> i64

Gets a signed n-byte integer from self in native-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_f32_ne(&mut self) -> f32

Gets an IEEE754 single-precision (4 bytes) floating point number from self in native-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 get_f64_ne(&mut self) -> f64

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

fn try_copy_to_slice(&mut self, dst: &mut [u8]) -> Result<(), TryGetError>

Copies bytes from self into dst.

fn try_get_u8(&mut self) -> Result<u8, TryGetError>

Gets an unsigned 8 bit integer from self.

fn try_get_i8(&mut self) -> Result<i8, TryGetError>

Gets a signed 8 bit integer from self.

fn try_get_u16(&mut self) -> Result<u16, TryGetError>

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

fn try_get_u16_le(&mut self) -> Result<u16, TryGetError>

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

fn try_get_u16_ne(&mut self) -> Result<u16, TryGetError>

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

fn try_get_i16(&mut self) -> Result<i16, TryGetError>

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

fn try_get_i16_le(&mut self) -> Result<i16, TryGetError>

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

fn try_get_i16_ne(&mut self) -> Result<i16, TryGetError>

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

fn try_get_u32(&mut self) -> Result<u32, TryGetError>

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

fn try_get_u32_le(&mut self) -> Result<u32, TryGetError>

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

fn try_get_u32_ne(&mut self) -> Result<u32, TryGetError>

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

fn try_get_i32(&mut self) -> Result<i32, TryGetError>

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

fn try_get_i32_le(&mut self) -> Result<i32, TryGetError>

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

fn try_get_i32_ne(&mut self) -> Result<i32, TryGetError>

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

fn try_get_u64(&mut self) -> Result<u64, TryGetError>

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

fn try_get_u64_le(&mut self) -> Result<u64, TryGetError>

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

fn try_get_u64_ne(&mut self) -> Result<u64, TryGetError>

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

fn try_get_i64(&mut self) -> Result<i64, TryGetError>

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

fn try_get_i64_le(&mut self) -> Result<i64, TryGetError>

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

fn try_get_i64_ne(&mut self) -> Result<i64, TryGetError>

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

fn try_get_u128(&mut self) -> Result<u128, TryGetError>

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

fn try_get_u128_le(&mut self) -> Result<u128, TryGetError>

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

fn try_get_u128_ne(&mut self) -> Result<u128, TryGetError>

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

fn try_get_i128(&mut self) -> Result<i128, TryGetError>

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

fn try_get_i128_le(&mut self) -> Result<i128, TryGetError>

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

fn try_get_i128_ne(&mut self) -> Result<i128, TryGetError>

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

fn try_get_uint(&mut self, nbytes: usize) -> Result<u64, TryGetError>

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

fn try_get_uint_le(&mut self, nbytes: usize) -> Result<u64, TryGetError>

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

fn try_get_uint_ne(&mut self, nbytes: usize) -> Result<u64, TryGetError>

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

fn try_get_int(&mut self, nbytes: usize) -> Result<i64, TryGetError>

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

fn try_get_int_le(&mut self, nbytes: usize) -> Result<i64, TryGetError>

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

fn try_get_int_ne(&mut self, nbytes: usize) -> Result<i64, TryGetError>

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

fn try_get_f32(&mut self) -> Result<f32, TryGetError>

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

fn try_get_f32_le(&mut self) -> Result<f32, TryGetError>

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

fn try_get_f32_ne(&mut self) -> Result<f32, TryGetError>

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

fn try_get_f64(&mut self) -> Result<f64, TryGetError>

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

fn try_get_f64_le(&mut self) -> Result<f64, TryGetError>

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

fn try_get_f64_ne(&mut self) -> Result<f64, TryGetError>

Gets an IEEE754 double-precision (8 bytes) floating point number from self in native-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>

where Self: Sized,

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

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

where U: Buf, Self: Sized,

Creates an adaptor which will chain this buffer with another.

fn reader(self) -> Reader<Self>

where Self: Sized,

Available on crate feature std only.

Creates an adaptor which implements the Read trait for self.

impl BufRead for BytesView

Because BytesView is already buffered, it implements BufRead directly without needing an intermediate buffer. Prefer this over wrapping in std::io::BufReader.

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

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amount: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

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

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

Checks if there is any data left to be read.

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

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

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

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

where Self: Sized,

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

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl Clone for BytesView

fn clone(&self) -> BytesView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BytesView

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

Formats the value using the given formatter.

impl Default for BytesView

fn default() -> Self

Returns the “default value” for a type.

impl From<Bytes> for BytesView

Available on crate features bytes-compat only.

fn from(value: Bytes) -> Self

Converts a Bytes instance into a BytesView.

This operation is always zero-copy, though does cost a small dynamic allocation.

impl From<BytesView> for BytesBuf

fn from(value: BytesView) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for BytesView

fn from(value: Vec<u8>) -> Self

Converts a Vec<u8> instance into a BytesView.

This operation is always zero-copy, though does cost a small dynamic allocation.

impl PartialEq<&[u8]> for BytesView

fn eq(&self, other: &&[u8]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const LEN: usize> PartialEq<&[u8; LEN]> for BytesView

fn eq(&self, other: &&[u8; LEN]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<BytesView> for &[u8]

fn eq(&self, other: &BytesView) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const LEN: usize> PartialEq<BytesView> for &[u8; LEN]

fn eq(&self, other: &BytesView) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for BytesView

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Read for BytesView

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>) -> Result<usize, Error>

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> 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, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

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

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

impl Eq for BytesView