Skip to main content

PieView

Struct PieView 

Source
pub struct PieView<'a, T> { /* private fields */ }
Expand description

A lightweight, temporary view into a PieList that borrows the backing ElemPool.

PieView bundles the list handle and the data pool together into a single, lightweight struct. This enables standard Rust traits like IntoIterator, Debug, and PartialEq, which require access to the data without passing a secondary pool argument.

Since PieView only holds shared references, it implements Copy and Clone regardless of whether the underlying type T implements them.

§Examples

§Printing (Debug)

use pie_core::{ElemPool, PieList};

let mut pool = ElemPool::new();
let mut list = PieList::new(&mut pool);
list.push_back(10, &mut pool).unwrap();
list.push_back(20, &mut pool).unwrap();

let view = list.view(&pool);
assert_eq!(format!("{:?}", view), "[10, 20]");

list.clear(&mut pool);

§Iterating

let view = list.view(&pool);

let mut sum = 0;
for &item in view {
    sum += item;
}
assert_eq!(sum, 3);

§Equality

You can compare two lists for equality, even if they live in different pools.

let mut pool1 = ElemPool::new();
let mut list1 = PieList::new(&mut pool1);
list1.push_back("apple", &mut pool1).unwrap();

let mut pool2 = ElemPool::new();
let mut list2 = PieList::new(&mut pool2);
list2.push_back("apple", &mut pool2).unwrap();

// Compare views
assert_eq!(list1.view(&pool1), list2.view(&pool2));

Implementations§

Source§

impl<'a, T> PieView<'a, T>

Source

pub fn new(list: &'a PieList<T>, pool: &'a ElemPool<T>) -> Self

Creates a new view for the given list using the data in pool.

It is often more ergonomic to use PieList::view instead.

Source

pub fn len(&self) -> usize

Returns the number of elements in the list.

§Example
let view = list.view(&pool);
assert_eq!(view.len(), 0);
Source

pub fn is_empty(&self) -> bool

Returns true if the list is empty.

§Example
let view = list.view(&pool);
assert!(view.is_empty());
Source

pub fn front(&self) -> Option<&T>

Returns a reference to the front element.

§Example
let view = list.view(&pool);
assert_eq!(view.front(), Some(&10));
Source

pub fn back(&self) -> Option<&T>

Returns a reference to the back element.

§Example
let view = list.view(&pool);
assert_eq!(view.back(), Some(&10));
Source

pub fn iter(&self) -> Iter<'a, T>

Creates an iterator over the list’s elements.

§Example
let view = list.view(&pool);
let vec: Vec<_> = view.iter().copied().collect();
assert_eq!(vec, vec![1, 2]);

Trait Implementations§

Source§

impl<'a, T> Clone for PieView<'a, T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, T: Debug> Debug for PieView<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, T> IntoIterator for PieView<'a, T>

Source§

type Item = &'a T

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<'a, T: Ord> Ord for PieView<'a, T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<'a, T: PartialEq> PartialEq for PieView<'a, T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a, T: PartialOrd> PartialOrd for PieView<'a, T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a, T> Copy for PieView<'a, T>

Source§

impl<'a, T: Eq> Eq for PieView<'a, T>

Auto Trait Implementations§

§

impl<'a, T> Freeze for PieView<'a, T>

§

impl<'a, T> RefUnwindSafe for PieView<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for PieView<'a, T>
where T: Sync,

§

impl<'a, T> Sync for PieView<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for PieView<'a, T>

§

impl<'a, T> UnsafeUnpin for PieView<'a, T>

§

impl<'a, T> UnwindSafe for PieView<'a, T>
where T: RefUnwindSafe,

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> 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.