Skip to main content

LeanRef

Struct LeanRef 

Source
pub struct LeanRef<T = LeanAny> { /* private fields */ }
Expand description

An owned reference to a Lean object.

Unlike LeanBound, this is not tied to a Lean<'l> lifetime, so it can be stored in structs and sent across threads (if the underlying type is Send).

To use a LeanRef, convert it to a LeanBound using bind().

Implementations§

Source§

impl<T> LeanRef<T>

Source

pub fn bind<'l>(&self, _lean: Lean<'l>) -> LeanBound<'l, T>

Bind this reference to a Lean<'l> lifetime.

This converts LeanRef<T> to LeanBound<'l, T> for use with Lean APIs.

Source

pub unsafe fn from_owned_ptr(ptr: *mut lean_object) -> Self

Create a LeanRef from an owned pointer.

§Safety
  • ptr must be a valid Lean object pointer
  • The reference count must already be incremented for this instance
Source

pub fn as_ptr(&self) -> *mut lean_object

Get the raw pointer to the Lean object.

Source

pub fn into_unbound(self) -> LeanUnbound<T>

Convert this LeanRef to a thread-safe LeanUnbound.

This marks the object for multi-threaded use via lean_mark_mt(), enabling atomic reference counting.

§Example
let lean_ref: LeanRef<LeanString> = bound.unbind();
let unbound: LeanUnbound<LeanString> = lean_ref.into_unbound();
// unbound can now be safely sent across threads

Trait Implementations§

Source§

impl<T> Clone for LeanRef<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Drop for LeanRef<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl<T> From<LeanRef<T>> for LeanUnbound<T>

Source§

fn from(lean_ref: LeanRef<T>) -> Self

Converts to this type from the input type.
Source§

impl<T: Send> Send for LeanRef<T>

Source§

impl<T: Sync> Sync for LeanRef<T>

Auto Trait Implementations§

§

impl<T> Freeze for LeanRef<T>

§

impl<T> RefUnwindSafe for LeanRef<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for LeanRef<T>
where T: Unpin,

§

impl<T> UnwindSafe for LeanRef<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.