Struct rune::runtime::Mut

pub struct Mut<T: ?Sized> { /* private fields */ }

A strong mutable reference to the given type.

Implementations

impl<T: ?Sized> Mut<T>

pub fn from_static(value: &'static mut T) -> Mut<T>

Construct a static mutable reference.

pub fn map<U: ?Sized, F>(this: Self, f: F) -> Mut<U>

where F: FnOnce(&mut T) -> &mut U,

Map the interior reference of an owned mutable value.

Examples

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

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

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

pub fn try_map<U: ?Sized, F>(this: Self, f: F) -> Option<Mut<U>>

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

Try to map the mutable reference to a projection.

Examples

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

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

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

pub fn into_raw(this: Self) -> (NonNull<T>, RawMut)

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> AsMut<T> for Mut<T>

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

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

impl<T: ?Sized> AsRef<T> for Mut<T>

fn as_ref(&self) -> &T

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

impl<T> Debug for Mut<T>

where T: Debug + ?Sized,

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

Formats the value using the given formatter.

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

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: ?Sized> DerefMut for Mut<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl FromValue for Mut<Bytes>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<ControlFlow>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Format>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Function>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Future>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Generator<Vm>>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<GeneratorState>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Iterator>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Object>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Range>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<RangeFrom>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<RangeFull>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<RangeInclusive>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<RangeTo>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<RangeToInclusive>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Stream<Vm>>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<String>

fn from_value(value: Value) -> VmResult<Self>

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

impl<T> FromValue for Mut<T>

where T: Any,

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Tuple>

fn from_value(value: Value) -> VmResult<Self>

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

impl FromValue for Mut<Vec>

fn from_value(value: Value) -> VmResult<Self>

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

impl<F> Future for Mut<F>

where F: Unpin + Future,

type Output = <F as Future>::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<T> MaybeTypeOf for Mut<T>

where T: ?Sized + MaybeTypeOf,

fn maybe_type_of() -> Option<FullTypeOf>

Type information for the given type.

impl<T> TypeOf for Mut<T>

where T: ?Sized + TypeOf,

Blanket implementation for owned mutable references.

fn type_of() -> FullTypeOf

Type information for the given type.

fn type_parameters() -> Hash

Hash of type parameters.

fn type_hash() -> Hash

Get full type hash, including type parameters.

fn type_info() -> TypeInfo

Access diagnostical information on the value type.