Struct half_edge_mesh::ptr::Ptr

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

Ptr is essentially a wrapper around Option<Weak<RefCell<T>>>, a.k.a. a nullable ref-counted pointer with interior mutability This abstraction is used to get around Rust's validity, borrowing, and ownership rules, especially when constructing or extending the half-edge mesh.

Methods

impl<T> Ptr<T>

pub fn new_rc(val: T) -> Rc<RefCell<T>>

Taken by value, so it moves the value out. Use this for constructing brand new objects. Returns an Rc<RefCell<T>>, not a Ptr<T>, don't get em mixed up

pub fn new(val: &Rc<RefCell<T>>) -> Ptr<T>

Taken by reference to an existing object. Creates a Ptr

pub fn empty() -> Ptr<T>

Creates what is effectively a null pointer

pub fn merge_upgrade(     weak_a: &Ptr<T>,     weak_b: &Ptr<T> ) -> Option<(RcRef<T>, RcRef<T>)>

Used as a utility function to merge the upgrade of two weak pointers into a single Option wrapping the success of both upgrades

pub fn is_valid(&self) -> bool

Check if the pointer is valid. Requires the pointer to upgrade in order to check that it still points at an existing object

pub fn upgrade(&self) -> Option<Rc<RefCell<T>>>

Used as a utility function for upgrading the stored weak pointer.

pub fn as_ref(&self) -> Option<&Weak<RefCell<T>>>

Converts from Option<Weak<RefCell<T>>> to Option<& Weak<RefCell<T>>> Like the function of the same name on Option

Trait Implementations

impl<T: Debug> Debug for Ptr<T>

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

Formats the value using the given formatter.

impl<T> Clone for Ptr<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.