Struct framering::RingFrameMut

pub struct RingFrameMut<'ring, T, Cap: Capacity> { /* fields omitted */ }

A mutable frame which allows elements to be appended to the end

Implementations

impl<'ring, T, Cap: Capacity> RingFrameMut<'ring, T, Cap>

pub fn next(self) -> (RingFrame<'ring, T, Cap>, RingFrameMut<'ring, T, Cap>)

Freezes the current frame and creates a new mutable frame

Example

let mut ring = FramedRing::<i32, Pow2Capacity>::new();
let frame = ring.frame();
let (frame_ro, frame2) = frame.next();

pub fn next_reserve(
    self,
    frame_capacity: usize
) -> (RingFrame<'ring, T, Cap>, RingFrameMut<'ring, T, Cap>)

Freezes the current frame and creates a new mutable frame with the given amount of reserved elements

Example

let mut ring = FramedRing::<i32, LinearCapacity>::new();
let frame = ring.frame();
let (frame_ro, frame2) = frame.next_reserve(4);
assert_eq!(ring.capacity(), 6);

pub fn push(&mut self, element: T)

Pushes an element onto the end of the frame

Example

let mut ring = FramedRing::<i32, Pow2Capacity>::new();
let mut frame = ring.frame();
frame.push(1);

pub fn reserve(&self, additional: usize)

Reserves capacity for at least additional more elements into the given frame. The given capacity may choose to reserve more space.

Example

let mut ring = FramedRing::<i32, LinearCapacity>::new();
let mut frame = ring.frame();
frame.reserve(4);
assert_eq!(ring.capacity(), 5);

pub fn downgrade(self) -> RingFrame<'ring, T, Cap>

Downgrades a RingFrameMut to a RingFrame without producing a successor.

Example

let mut ring = FramedRing::<i32, Pow2Capacity>::new();
let mut frame = ring.frame();
frame.downgrade();

Trait Implementations

impl<'ring, T, Cap: Capacity> AsRef<RingFrame<'ring, T, Cap>> for RingFrameMut<'ring, T, Cap>

pub fn as_ref(&self) -> &RingFrame<'ring, T, Cap>

Performs the conversion.

impl<'ring, T, Cap: Capacity> Extend<T> for RingFrameMut<'ring, T, Cap>

pub fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'ring, T, Cap: Capacity> From<RingFrameMut<'ring, T, Cap>> for RingFrame<'ring, T, Cap>

pub fn from(rfm: RingFrameMut<'ring, T, Cap>) -> Self

Performs the conversion.