Struct broccoli::pmut::PMut

#[repr(transparent)]
pub struct PMut<'a, T: ?Sized> { /* fields omitted */ }

A protected mutable reference that derefs to &T. See the pmut module documentation for more explanation.

Implementations

impl<'a, 'b: 'a, T> PMut<'a, PMut<'b, T>>

pub fn flatten(self) -> PMut<'a, T>

Flatten a double pointer

impl<'a, T> PMut<'a, T>

pub fn into_slice(self) -> PMut<'a, [T]>

Convert a PMut<T> inside a PMut<[T]> of size one.

impl<'a, T: ?Sized> PMut<'a, T>

pub fn new(inner: &'a mut T) -> PMut<'a, T>

Create a protected pointer.

pub fn shorten<'c>(self) -> PMut<'c, T> where
    'a: 'c, 

pub fn borrow_mut(&mut self) -> PMut<'_, T>

Start a new borrow lifetime

pub fn into_ref(self) -> &'a T

pub unsafe fn into_inner(self) -> &'a mut T

If this function were safe, it would defeat the purpose of this type.

Safety

This is unsafe, since the user may mutate the inner AABB while T is inserted in a tree thus undoing the whole point of this struct.

impl<'a, 'b: 'a, T: Aabb> PMut<'a, Node<'b, T>>

pub fn into_node_ref(self) -> NodeRef<'a, T>

Destructure a node into its three parts.

pub fn get_cont(&self) -> &'a Range<T::Num>

pub fn into_range(self) -> PMut<'a, [T]>

Return a mutable list of elements in this node.

impl<'a, T: Aabb> PMut<'a, T>

pub fn rect(&self) -> &'a Rect<T::Num>

Return a read-only reference to the aabb. Note the lifetime. Given the guarentees of the Aabb trait, we can have this extended lifetime.

pub fn unpack_rect(self) -> &'a Rect<T::Num>

impl<'a, T: HasInner> PMut<'a, T>

pub fn unpack_inner(self) -> &'a mut T::Inner

Unpack only the mutable innner component

impl<'a, T> PMut<'a, [T]>

pub fn get_index_mut(self, ind: usize) -> PMut<'a, T>

Return the element at the specified index. We can’t use the index trait because we don’t want to return a mutable reference.

pub fn split_first_mut(self) -> Option<(PMut<'a, T>, PMut<'a, [T]>)>

Split off the first element.

pub fn truncate_to(self, a: RangeTo<usize>) -> Self

Return a smaller slice that ends with the specified index.

pub fn truncate_from(self, a: RangeFrom<usize>) -> Self

Return a smaller slice that starts at the specified index.

pub fn truncate(self, a: Range<usize>) -> Self

Return a smaller slice that starts and ends with the specified range.

pub fn iter_mut(self) -> PMutIter<'a, T>

Return a mutable iterator.

Trait Implementations

impl<'a, T: Aabb> Aabb for PMut<'a, T>

type Num = T::Num

fn get(&self) -> &Rect<Self::Num>

impl<'a, T: Debug + ?Sized> Debug for PMut<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: ?Sized> Deref for PMut<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T> IntoIterator for PMut<'a, [T]>

type Item = PMut<'a, T>

The type of the elements being iterated over.

type IntoIter = PMutIter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.