Struct ocaml::Pointer

#[repr(transparent)]
pub struct Pointer<T>(pub Value, _);

A handle to a Rust value/reference owned by the OCaml heap.

This should only be used with values allocated with alloc_final or alloc_custom, for abstract pointers see Value::alloc_abstract_ptr and Value::abstract_ptr_val

Tuple Fields

0: Value

Implementations

impl<T: Custom> Pointer<T>

pub fn alloc_custom(x: T) -> Pointer<T> where
    T: Custom, 

Allocate a Custom value

impl<T> Pointer<T>

pub fn alloc_final(
    x: T,
    finalizer: Option<unsafe extern "C" fn(_: Raw)>,
    used_max: Option<(usize, usize)>
) -> Pointer<T>

Allocate a new value with an optional custom finalizer and used/max

This calls caml_alloc_final under-the-hood, which can has less than ideal performance behavior. In most cases you should prefer Poiner::alloc_custom when possible.

pub fn alloc(x: T) -> Pointer<T>

Allocate a new abstract value

pub unsafe fn drop_in_place(self)

Drop pointer in place

Safety

This should only be used when you’re in control of the underlying value and want to drop it. It should only be called once.

pub fn set(&mut self, x: T)

Replace the inner value with the provided argument

pub fn as_ptr(&self) -> *const T

Access the underlying pointer

pub fn as_mut_ptr(&mut self) -> *mut T

Access the underlying mutable pointer

Trait Implementations

impl<T> AsMut<T> for Pointer<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for Pointer<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Pointer<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Custom> From<T> for Pointer<T>

fn from(x: T) -> Self

Converts to this type from the input type.

impl<T> FromValue for Pointer<T>

fn from_value(value: Value) -> Self

Convert from OCaml value

impl<T: PartialEq> PartialEq<Pointer<T>> for Pointer<T>

fn eq(&self, other: &Pointer<T>) -> bool

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

fn ne(&self, other: &Pointer<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Pointer<T>> for Pointer<T>

fn partial_cmp(&self, other: &Pointer<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> ToValue for Pointer<T>

fn to_value(&self, _rt: &Runtime) -> Value

Convert to OCaml value

impl<T: Eq> Eq for Pointer<T>

impl<T> StructuralEq for Pointer<T>

impl<T> StructuralPartialEq for Pointer<T>