Struct koto_memory::Ptr

pub struct Ptr<T: ?Sized>(/* private fields */);

An immutable pointer to a value in allocated memory

Implementations

impl<T> Ptr<T>

pub fn new(value: T) -> Self

Moves the provided value into newly allocated memory

impl<T: ?Sized> Ptr<T>

pub fn ptr_eq(this: &Self, other: &Self) -> bool

Returns true if the two Ptrs point to the same allocation

See also: std::sync::Arc::ptr_eq

pub fn address(this: &Self) -> Address

Returns the address of the allocated memory

pub fn ref_count(this: &Self) -> usize

Returns the number of references to the allocated memory

Only strong references are counted, weak references don’t get added to the result.

impl<T: Clone> Ptr<T>

pub fn make_mut(this: &mut Self) -> &mut T

Makes a mutable reference into the owned T

If the pointer has the only reference to the value, then the reference will be returned. Otherwise a clone of the value will be made to ensure uniqueness before returning the reference.

See also: std::sync::Arc::make_mut

Trait Implementations

impl<T: ?Sized> 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.

impl<T: Debug + ?Sized> Debug for Ptr<T>

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

Formats the value using the given formatter.

impl<T: Default + ?Sized> Default for Ptr<T>

fn default() -> Ptr<T>

Returns the “default value” for a type.

impl<T: ?Sized> Deref for Ptr<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: ?Sized + Display> Display for Ptr<T>

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

Formats the value using the given formatter.

impl<T: Clone> From<&[T]> for Ptr<[T]>

fn from(value: &[T]) -> Self

Converts to this type from the input type.

impl From<&str> for Ptr<str>

fn from(value: &str) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<Arc<T>> for Ptr<T>

fn from(inner: Arc<T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized> From<Box<T>> for Ptr<T>

fn from(boxed: Box<T>) -> Self

Converts to this type from the input type.

impl From<String> for Ptr<str>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<T> From<T> for Ptr<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for Ptr<[T]>

fn from(value: Vec<T>) -> Self

Converts to this type from the input type.

impl<T: ?Sized + Hash> Hash for Ptr<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: ?Sized + Ord> Ord for Ptr<T>

fn cmp(&self, other: &Ptr<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: ?Sized + PartialEq> PartialEq for Ptr<T>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized + PartialOrd> PartialOrd for Ptr<T>

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

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

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

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

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

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

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

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

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

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

impl<T: ?Sized + Eq> Eq for Ptr<T>