Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer<T: Clone> { /* private fields */ }
Expand description

A reference-counted buffer with copy-on-write semantics.

Internally backed by Rc<RefCell<Vec<T>>>. When multiple Buffers share the same underlying storage, a mutation via Buffer::set or Buffer::make_unique triggers a deep copy so that other holders are unaffected.

Implementations§

Source§

impl<T: Clone> Buffer<T>

Source

pub fn alloc(len: usize, default: T) -> Self

Allocate a buffer of len elements, each initialized to default.

Source

pub fn from_vec(data: Vec<T>) -> Self

Create a buffer from an existing Vec<T>.

Source

pub fn len(&self) -> usize

Number of elements in the buffer.

Source

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Source

pub fn get(&self, idx: usize) -> Option<T>

Read the value at idx. Returns None if out of bounds.

Source

pub fn set(&mut self, idx: usize, val: T) -> Result<(), RuntimeError>

Write val at idx. If the buffer is shared (refcount > 1), a deep copy is performed first (COW). Returns Err if idx is out of bounds.

Source

pub fn as_slice(&self) -> Vec<T>

Return a snapshot of the data as a Vec<T>.

Source

pub fn borrow_data(&self) -> Ref<'_, Vec<T>>

Borrow the underlying Vec without cloning. The returned Ref guard keeps the borrow alive.

Source

pub fn clone_buffer(&self) -> Buffer<T>

Force a deep copy, returning a new Buffer that does not share storage with self.

Source

pub fn make_unique(&mut self)

Ensure this Buffer has exclusive ownership of the underlying data. If the refcount is > 1, the data is deep-copied and this Buffer is re-pointed to the fresh copy.

Source

pub fn refcount(&self) -> usize

Number of live references to the underlying storage.

Trait Implementations§

Source§

impl<T: Clone> Clone for Buffer<T>

Source§

fn clone(&self) -> Self

Cloning a Buffer increments the refcount — it does NOT copy data.

1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Clone> Debug for Buffer<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Buffer<T>

§

impl<T> !RefUnwindSafe for Buffer<T>

§

impl<T> !Send for Buffer<T>

§

impl<T> !Sync for Buffer<T>

§

impl<T> Unpin for Buffer<T>

§

impl<T> UnsafeUnpin for Buffer<T>

§

impl<T> !UnwindSafe for Buffer<T>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.