Struct DivBufShared 

pub struct DivBufShared { /* private fields */ }

The “entry point” to the divbuf crate.

A DivBufShared owns storage, but cannot directly access it. An application will typically create an instance of this class for every independent buffer it wants to manage, and then create child DivBufs or DivBufMuts to access the storage.

Implementations

impl DivBufShared

pub fn capacity(&self) -> usize

Returns the number of bytes the buffer can hold without reallocating.

pub fn is_empty(&self) -> bool

Returns true if the DivBufShared has length 0

pub fn len(&self) -> usize

Returns the number of bytes contained in this buffer.

pub fn try_const(&self) -> Result<DivBuf, Error>

Try to create a read-only DivBuf that refers to the entirety of this buffer. Will fail if there are any DivBufMut objects referring to this buffer.

Examples

let dbs = DivBufShared::with_capacity(4096);
let db = dbs.try_const().unwrap();

pub fn try_mut(&self) -> Result<DivBufMut, Error>

Try to create a mutable DivBufMut that refers to the entirety of this buffer. Will fail if there are any DivBufMut or DivBuf objects referring to this buffer.

Examples

let dbs = DivBufShared::with_capacity(4096);
let dbm = dbs.try_mut().unwrap();

pub fn uninitialized(capacity: usize) -> Self

Available on crate feature experimental only.

Create a new DivBufShared with an uninitialized buffer of specified length.

Safety

This method technically causes undefined behavior, but it works with current compilers. A good replacement is not possible until the read-buf feature stabilizes.

https://github.com/rust-lang/rust/issues/78485

pub fn with_capacity(capacity: usize) -> Self

Creates a new, empty, DivBufShared with a specified capacity.

After constructing a DivBufShared this way, it can only be populated via a child DivBufMut.

Trait Implementations

impl Debug for DivBufShared

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

Formats the value using the given formatter.

impl Drop for DivBufShared

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> From<&'a [u8]> for DivBufShared

fn from(src: &'a [u8]) -> DivBufShared

Converts to this type from the input type.

impl From<Vec<u8>> for DivBufShared

fn from(src: Vec<u8>) -> DivBufShared

Converts to this type from the input type.

impl TryFrom<DivBufShared> for Vec<u8>

fn try_from(buf: DivBufShared) -> Result<Self, Self::Error>

Attempt to extract the owned storage from a DivBufShared.

This will fail if there are any other living references to this same DivBufShared (DivBufs, DivBufMuts, etc), in which case the DivBufShared will be returned unmodified.

Examples

use std::convert::TryInto;
let dbs = DivBufShared::from(vec![1, 2, 3, 4, 5, 6]);
let vec: Vec<u8> = dbs.try_into().unwrap();
assert_eq!(vec, vec![1, 2, 3, 4, 5, 6]);

type Error = DivBufShared

The type returned in the event of a conversion error.

impl Send for DivBufShared

impl Sync for DivBufShared