Struct rune::runtime::BorrowRef

pub struct BorrowRef<'a, T: ?Sized + 'a> { /* private fields */ }

Guard for a data borrowed from a slot in the virtual machine.

These guards are necessary, since we need to guarantee certain forms of access depending on what we do. Releasing the guard releases the access.

Implementations

impl<'a, T: ?Sized> BorrowRef<'a, T>

pub fn map<M, U: ?Sized>(this: Self, m: M) -> BorrowRef<'a, U>

where M: FnOnce(&T) -> &U,

Map the reference.

Examples

use rune::runtime::{BorrowRef, Shared};

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

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

pub fn try_map<M, U: ?Sized>(this: Self, m: M) -> Option<BorrowRef<'a, U>>

where M: FnOnce(&T) -> Option<&U>,

Try to map the reference to a projection.

Examples

use rune::runtime::{BorrowRef, Shared};

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

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

Trait Implementations

impl<T> Debug for BorrowRef<'_, T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for BorrowRef<'_, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.