Struct radix_engine::types::RefCell

1.0.0 · source ·
pub struct RefCell<T>
where T: ?Sized,
{ borrow: Cell<isize>, value: UnsafeCell<T>, }
Expand description

A mutable memory location with dynamically checked borrow rules

See the module-level documentation for more.

Fields§

§borrow: Cell<isize>§value: UnsafeCell<T>

Implementations§

source§

impl<T> RefCell<T>

const: 1.24.0 · source

pub const fn new(value: T) -> RefCell<T>

Creates a new RefCell containing value.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);
const: unstable · source

pub fn into_inner(self) -> T

Consumes the RefCell, returning the wrapped value.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

let five = c.into_inner();
1.24.0 · source

pub fn replace(&self, t: T) -> T

Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.

This function corresponds to std::mem::replace.

§Panics

Panics if the value is currently borrowed.

§Examples
use std::cell::RefCell;
let cell = RefCell::new(5);
let old_value = cell.replace(6);
assert_eq!(old_value, 5);
assert_eq!(cell, RefCell::new(6));
1.35.0 · source

pub fn replace_with<F>(&self, f: F) -> T
where F: FnOnce(&mut T) -> T,

Replaces the wrapped value with a new one computed from f, returning the old value, without deinitializing either one.

§Panics

Panics if the value is currently borrowed.

§Examples
use std::cell::RefCell;
let cell = RefCell::new(5);
let old_value = cell.replace_with(|&mut old| old + 1);
assert_eq!(old_value, 5);
assert_eq!(cell, RefCell::new(6));
1.24.0 · source

pub fn swap(&self, other: &RefCell<T>)

Swaps the wrapped value of self with the wrapped value of other, without deinitializing either one.

This function corresponds to std::mem::swap.

§Panics

Panics if the value in either RefCell is currently borrowed, or if self and other point to the same RefCell.

§Examples
use std::cell::RefCell;
let c = RefCell::new(5);
let d = RefCell::new(6);
c.swap(&d);
assert_eq!(c, RefCell::new(6));
assert_eq!(d, RefCell::new(5));
source§

impl<T> RefCell<T>
where T: ?Sized,

source

pub fn borrow(&self) -> Ref<'_, T>

Immutably borrows the wrapped value.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

§Panics

Panics if the value is currently mutably borrowed. For a non-panicking variant, use try_borrow.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

let borrowed_five = c.borrow();
let borrowed_five2 = c.borrow();

An example of panic:

use std::cell::RefCell;

let c = RefCell::new(5);

let m = c.borrow_mut();
let b = c.borrow(); // this causes a panic
1.13.0 · source

pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError>

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of borrow.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow_mut();
    assert!(c.try_borrow().is_err());
}

{
    let m = c.borrow();
    assert!(c.try_borrow().is_ok());
}
source

pub fn borrow_mut(&self) -> RefMut<'_, T>

Mutably borrows the wrapped value.

The borrow lasts until the returned RefMut or all RefMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

§Panics

Panics if the value is currently borrowed. For a non-panicking variant, use try_borrow_mut.

§Examples
use std::cell::RefCell;

let c = RefCell::new("hello".to_owned());

*c.borrow_mut() = "bonjour".to_owned();

assert_eq!(&*c.borrow(), "bonjour");

An example of panic:

use std::cell::RefCell;

let c = RefCell::new(5);
let m = c.borrow();

let b = c.borrow_mut(); // this causes a panic
1.13.0 · source

pub fn try_borrow_mut(&self) -> Result<RefMut<'_, T>, BorrowMutError>

Mutably borrows the wrapped value, returning an error if the value is currently borrowed.

The borrow lasts until the returned RefMut or all RefMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow();
    assert!(c.try_borrow_mut().is_err());
}

assert!(c.try_borrow_mut().is_ok());
1.12.0 · source

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

Returns a raw pointer to the underlying data in this cell.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

let ptr = c.as_ptr();
1.11.0 · source

pub fn get_mut(&mut self) -> &mut T

Returns a mutable reference to the underlying data.

Since this method borrows RefCell mutably, it is statically guaranteed that no borrows to the underlying data exist. The dynamic checks inherent in borrow_mut and most other methods of RefCell are therefore unnecessary.

This method can only be called if RefCell can be mutably borrowed, which in general is only the case directly after the RefCell has been created. In these situations, skipping the aforementioned dynamic borrowing checks may yield better ergonomics and runtime-performance.

In most situations where RefCell is used, it can’t be borrowed mutably. Use borrow_mut to get mutable access to the underlying data then.

§Examples
use std::cell::RefCell;

let mut c = RefCell::new(5);
*c.get_mut() += 1;

assert_eq!(c, RefCell::new(6));
source

pub fn undo_leak(&mut self) -> &mut T

🔬This is a nightly-only experimental API. (cell_leak)

Undo the effect of leaked guards on the borrow state of the RefCell.

This call is similar to get_mut but more specialized. It borrows RefCell mutably to ensure no borrows exist and then resets the state tracking shared borrows. This is relevant if some Ref or RefMut borrows have been leaked.

§Examples
#![feature(cell_leak)]
use std::cell::RefCell;

let mut c = RefCell::new(0);
std::mem::forget(c.borrow_mut());

assert!(c.try_borrow().is_err());
c.undo_leak();
assert!(c.try_borrow().is_ok());
1.37.0 · source

pub unsafe fn try_borrow_unguarded(&self) -> Result<&T, BorrowError>

Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.

§Safety

Unlike RefCell::borrow, this method is unsafe because it does not return a Ref, thus leaving the borrow flag untouched. Mutably borrowing the RefCell while the reference returned by this method is alive is undefined behaviour.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);

{
    let m = c.borrow_mut();
    assert!(unsafe { c.try_borrow_unguarded() }.is_err());
}

{
    let m = c.borrow();
    assert!(unsafe { c.try_borrow_unguarded() }.is_ok());
}
source§

impl<T> RefCell<T>
where T: Default,

1.50.0 · source

pub fn take(&self) -> T

Takes the wrapped value, leaving Default::default() in its place.

§Panics

Panics if the value is currently borrowed.

§Examples
use std::cell::RefCell;

let c = RefCell::new(5);
let five = c.take();

assert_eq!(five, 5);
assert_eq!(c.into_inner(), 0);

Trait Implementations§

source§

impl<X, T> Categorize<X> for RefCell<T>
where X: CustomValueKind, T: Categorize<X>,

source§

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

source§

fn clone(&self) -> RefCell<T>

§Panics

Panics if the value is currently mutably borrowed.

source§

fn clone_from(&mut self, other: &RefCell<T>)

§Panics

Panics if other is currently mutably borrowed.

source§

impl<T> Debug for RefCell<T>
where T: Debug + ?Sized,

source§

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

Formats the value using the given formatter. Read more
source§

impl<X, D, T> Decode<X, D> for RefCell<T>
where X: CustomValueKind, D: Decoder<X>, T: Decode<X, D>,

source§

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X> ) -> Result<RefCell<T>, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind. Read more
source§

impl<T> Default for RefCell<T>
where T: Default,

source§

fn default() -> RefCell<T>

Creates a RefCell<T>, with the Default value for T.

source§

impl<C, T> Describe<C> for RefCell<T>

source§

const TYPE_ID: RustTypeId = T::TYPE_ID

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed. Read more
source§

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type. Read more
source§

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator. Read more
source§

impl<'de, T> Deserialize<'de> for RefCell<T>
where T: Deserialize<'de>,

source§

fn deserialize<D>( deserializer: D ) -> Result<RefCell<T>, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<X, E, T> Encode<X, E> for RefCell<T>
where X: CustomValueKind, E: Encoder<X>, T: Encode<X, E>,

source§

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder
source§

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder. Read more
1.12.0 · source§

impl<T> From<T> for RefCell<T>

source§

fn from(t: T) -> RefCell<T>

Creates a new RefCell<T> containing the given value.

1.10.0 · source§

impl<T> Ord for RefCell<T>
where T: Ord + ?Sized,

source§

fn cmp(&self, other: &RefCell<T>) -> Ordering

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

impl<T> PartialEq for RefCell<T>
where T: PartialEq + ?Sized,

source§

fn eq(&self, other: &RefCell<T>) -> bool

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
1.10.0 · source§

impl<T> PartialOrd for RefCell<T>
where T: PartialOrd + ?Sized,

source§

fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering>

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

fn lt(&self, other: &RefCell<T>) -> bool

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

fn le(&self, other: &RefCell<T>) -> bool

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

fn gt(&self, other: &RefCell<T>) -> bool

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

fn ge(&self, other: &RefCell<T>) -> bool

§Panics

Panics if the value in either RefCell is currently mutably borrowed.

source§

impl<'a, X, T> SborEnum<X> for RefCell<T>
where X: CustomValueKind, T: SborEnum<X>,

source§

impl<'a, X, T> SborTuple<X> for RefCell<T>
where X: CustomValueKind, T: SborTuple<X>,

source§

impl<T> Serialize for RefCell<T>
where T: Serialize + ?Sized,

source§

fn serialize<S>( &self, serializer: S ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl<T, U> CoerceUnsized<RefCell<U>> for RefCell<T>
where T: CoerceUnsized<U>,

1.2.0 · source§

impl<T> Eq for RefCell<T>
where T: Eq + ?Sized,

source§

impl<T> Send for RefCell<T>
where T: Send + ?Sized,

source§

impl<T> !Sync for RefCell<T>
where T: ?Sized,

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for RefCell<T>

§

impl<T: ?Sized> Unpin for RefCell<T>
where T: Unpin,

§

impl<T: ?Sized> UnwindSafe for RefCell<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
§

impl<U> As for U

§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. 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
§

impl<T1> DecodeUntypedSlice for T1
where T1: From<UntypedValue>,

§

fn decode_untyped_slice(results: &[UntypedValue]) -> Result<T1, UntypedError>

Decodes the slice of [UntypedValue] as a value of type Self. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> ResolvableArguments for T

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> BasicCategorize for T

source§

impl<T> BasicDecode for T

source§

impl<T> BasicDescribe for T

source§

impl<T> BasicEncode for T

source§

impl<T> BasicSbor for T

source§

impl<T> BasicSborEnum for T

source§

impl<T> BasicSborTuple for T

source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> ManifestCategorize for T

source§

impl<T> ManifestDecode for T

source§

impl<T> ManifestEncode for T

source§

impl<T> ManifestSborEnum for T

source§

impl<T> ManifestSborTuple for T

source§

impl<T> ScryptoCategorize for T

source§

impl<T> ScryptoDecode for T

source§

impl<T> ScryptoDescribe for T

source§

impl<T> ScryptoEncode for T

source§

impl<T> ScryptoSbor for T

source§

impl<T> ScryptoSborEnum for T

source§

impl<T> ScryptoSborTuple for T