Struct arae::Cursor

pub struct Cursor<T> { /* fields omitted */ }

An structure that represents a location within a Cursed structure.

A Cursor is created from and used with initialized its owning Cursed structure, however if the structure is dropped, will point to invalid memory.

Safety is achieved via Cursor validating it's owned by the Cursed structure.

Methods

impl<T> Cursor<T>

pub fn new(ptr: NonNull<T>) -> Self

Constructs a new Cursor given a non-null pointer.

pub fn get<C>(self, cursed: &C) -> &T where
    C: Cursed<T>, 

Returns a reference to the element the Cursor is pointing to.

Example

use arae::{CurVec, Bounded};

let mut vec: CurVec<_> = vec![0].into();

let cursor = vec.head();

assert_eq!(*cursor.get(&vec), 0);

Panics

Panics if cursed does not own self.

pub fn get_mut<C>(self, cursed: &mut C) -> &mut T where
    C: Cursed<T>, 

Returns a mutable reference to the element the Cursor is pointing to.

Example

use arae::{CurVec, Bounded};

let mut vec: CurVec<_> = vec![0].into();

let cursor = vec.head();

*cursor.get_mut(&mut vec) = 1;

assert_eq!(*cursor.get(&vec), 1);

Panics

Panics if cursed does not own self.

pub unsafe fn new_unchecked(ptr: *mut T) -> Self

Constructs a new Cursor given a unchecked pointer.

Safety

Must not be null, see NonNull::new_unchecked safety notes.

pub fn ptr(self) -> NonNull<T>

Returns the Cursor's underlying pointer.

pub fn into_atomic(self) -> AtomicCursor<T>

Converts the cursor into an atomic variant.

Trait Implementations

impl<T> Clone for Cursor<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Cursor<T>

impl<T> Debug for Cursor<T>

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

Formats the value using the given formatter.

impl<T> Eq for Cursor<T>

impl<T> From<AtomicCursor<T>> for Cursor<T>

fn from(cursor: AtomicCursor<T>) -> Self

Performs the conversion.

impl<T> From<Cursor<T>> for AtomicCursor<T>

fn from(cursor: Cursor<T>) -> Self

Performs the conversion.

impl<T> Ord for Cursor<T>

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T> PartialEq<Cursor<T>> for Cursor<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> PartialOrd<Cursor<T>> for Cursor<T>

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

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.