Struct koto_runtime::Ptr

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

An immutable pointer to a value in allocated memory

Implementations

impl<T> Ptr<T>

pub fn new(value: T) -> Ptr<T>

Moves the provided value into newly allocated memory

impl<T> Ptr<T>

where T: ?Sized,

pub fn ptr_eq(this: &Ptr<T>, other: &Ptr<T>) -> bool

Returns true if the two Ptrs point to the same allocation

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

pub fn address(this: &Ptr<T>) -> Address

Returns the address of the allocated memory

pub fn ref_count(this: &Ptr<T>) -> 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> Ptr<T>

where T: Clone,

pub fn make_mut(this: &mut Ptr<T>) -> &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> Clone for Ptr<T>

where T: ?Sized,

fn clone(&self) -> Ptr<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Ptr<T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<T> Default for Ptr<T>

where T: Default + ?Sized,

fn default() -> Ptr<T>

Returns the “default value” for a type.

impl<T> Deref for Ptr<T>

where T: ?Sized,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Display for Ptr<T>

where T: Display + ?Sized,

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

Formats the value using the given formatter.

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

where T: Clone,

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

Converts to this type from the input type.

impl From<&str> for Ptr<str>

fn from(value: &str) -> Ptr<str>

Converts to this type from the input type.

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

where T: ?Sized,

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

Converts to this type from the input type.

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

where T: ?Sized,

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

Converts to this type from the input type.

impl From<Ptr<Chunk>> for Chunk

fn from(inner: Ptr<Chunk>) -> Self

Converts to this type from the input type.

impl From<Ptr<str>> for KString

fn from(string: Ptr<str>) -> Self

Converts to this type from the input type.

impl From<String> for Ptr<str>

fn from(value: String) -> Ptr<str>

Converts to this type from the input type.

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

fn from(value: T) -> Ptr<KCell<T>>

Converts to this type from the input type.

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

fn from(value: T) -> Ptr<T>

Converts to this type from the input type.

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

fn from(value: Vec<T>) -> Ptr<[T]>

Converts to this type from the input type.

impl<T> Hash for Ptr<T>

where T: Hash + ?Sized,

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

where H: Hasher,

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> Ord for Ptr<T>

where T: Ord + ?Sized,

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> PartialEq for Ptr<T>

where T: PartialEq + ?Sized,

fn eq(&self, other: &Ptr<T>) -> 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> PartialOrd for Ptr<T>

where T: PartialOrd + ?Sized,

fn partial_cmp(&self, other: &Ptr<T>) -> 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> Eq for Ptr<T>

where T: Eq + ?Sized,