Struct runestick::Ref

pub struct Ref<T: ?Sized> { /* fields omitted */ }

A strong reference to the given type.

Implementations

impl<T: ?Sized> Ref<T>

pub fn map<U: ?Sized, F>(this: Self, f: F) -> Ref<U> where
    F: FnOnce(&T) -> &U, 

Map the interior reference of an owned mutable value.

Examples

use runestick::{Ref, Shared};

let vec = Shared::<Vec<u32>>::new(vec![1, 2, 3, 4]);
let vec = vec.into_ref()?;
let value: Ref<[u32]> = Ref::map(vec, |vec| &vec[0..2]);

assert_eq!(&*value, &[1u32, 2u32][..]);

pub fn try_map<U: ?Sized, F>(this: Self, f: F) -> Option<Ref<U>> where
    F: FnOnce(&T) -> Option<&U>, 

Try to map the reference to a projection.

Examples

use runestick::{Ref, Shared};

let vec = Shared::<Vec<u32>>::new(vec![1, 2, 3, 4]);
let vec = vec.into_ref()?;
let value: Option<Ref<[u32]>> = Ref::try_map(vec, |vec| vec.get(0..2));

assert_eq!(value.as_deref(), Some(&[1u32, 2u32][..]));

pub fn into_raw(this: Self) -> (*const T, RawRef)

Convert into a raw pointer and associated raw access guard.

Safety

The returned pointer must not outlive the associated guard, since this prevents other uses of the underlying data which is incompatible with the current.

Trait Implementations

impl<T: ?Sized> Debug for Ref<T> where
    T: Debug, 

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> FromValue for Ref<T> where
    T: Any, 

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<String>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<Function>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<Object>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<Range>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<Tuple>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl FromValue for Ref<Vec>

fn from_value(value: Value) -> Result<Self, VmError>

Try to convert to the given type, from the given value.

impl<T: ?Sized> TypeOf for Ref<T> where
    T: TypeOf, 

Blanket implementation for owned references.

fn type_hash() -> Hash

Convert into a type hash.

fn type_info() -> TypeInfo

Access diagnostical information on the value type.