Struct jlrs::wrappers::ptr::Ref

#[repr(transparent)]
pub struct Ref<'scope, 'data, T: Wrapper<'scope, 'data>>(_, _, _);

An unrooted reference to Julia data.

Pointer wrappers are generally guaranteed to wrap valid, rooted data. In some cases this guarantee is too strong. The garbage collector uses the roots as a starting point to determine what values can be reached, as long as you can guarantee a value is reachable it’s safe to use. Whenever data is not rooted jlrs returns a Ref. Because it’s not rooted it’s unsafe to use.

Implementations

impl<'scope, 'data, T: Wrapper<'scope, 'data>> Ref<'scope, 'data, T>

pub fn undefined_ref() -> Ref<'scope, 'data, T>

An undefined reference, i.e. a null pointer.

pub fn is_undefined(self) -> bool

Returns true if the reference is undefined.

pub unsafe fn wrapper(self) -> Option<T>

Assume the reference still points to valid Julia data and convert it to its wrapper type. Returns None if the reference is undefined.

Safety: a reference is only valid as long as it’s reachable through some rooted value. It’s the caller’s responsibility to ensure the result is never used after it becomes unreachable.

pub unsafe fn wrapper_unchecked(self) -> T

Assume the reference still points to valid Julia data and convert it to its wrapper type.

Safety: this method doesn’t check if the reference is undefined, a reference is only valid as long as it’s reachable through some rooted value. It’s the caller’s responsibility to ensure the result is never used after it becomes unreachable.

pub unsafe fn root<'target, 'current, S, F>(
    self,
    scope: S
) -> JlrsResult<S::Value> where
    S: Scope<'target, 'current, 'data, F>,
    F: Frame<'current>, 

Assume the reference still points to valid Julia data and root it in scope. Returns an error if the reference is undefined.

Safety: a reference is only valid as long as it’s reachable through some rooted value.

pub unsafe fn value(self) -> Option<Value<'scope, 'data>>

Assume the reference still points to valid Julia data and convert it to a Value. Returns None if the reference is undefined.

Safety: a reference is only valid as long as it’s reachable through some rooted value. It’s the caller’s responsibility to ensure the result is never used after it becomes unreachable.

pub unsafe fn value_unchecked(self) -> Value<'scope, 'data>

Assume the reference still points to valid Julia data and convert it to a Value.

Safety: this method doesn’t check if the reference is undefined, a reference is only valid as long as it’s reachable through some rooted value. It’s the caller’s responsibility to ensure the result is never used after it becomes unreachable.

Trait Implementations

impl<'scope, 'data, T: Clone + Wrapper<'scope, 'data>> Clone for Ref<'scope, 'data, T> where
    T::Wraps: Clone, 

fn clone(&self) -> Ref<'scope, 'data, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'scope, 'data, T: Wrapper<'scope, 'data>> Debug for Ref<'scope, 'data, T>

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

Formats the value using the given formatter.

impl<'scope, 'data, T: Copy + Wrapper<'scope, 'data>> Copy for Ref<'scope, 'data, T> where
    T::Wraps: Copy,