Skip to main content

Memory

Struct Memory 

Source
pub struct Memory {
    pub buffer: Rc<RefCell<Vec<u8>>>,
    pub len: usize,
    /* private fields */
}
Expand description

A cheaply clonable callframe-shared memory buffer.

When a new callframe is created a RC clone of this memory is made, with the current base offset at the length of the buffer at that time.

Fields§

§buffer: Rc<RefCell<Vec<u8>>>§len: usize

Implementations§

Source§

impl Memory

Source

pub fn new() -> Self

Source

pub fn reset_for_reuse(&mut self)

Resets this memory so its buffer can be reused from a pool by the next transaction: drops all contents (length → 0, capacity retained) and rebases to 0.

Truncating the buffer to length 0 is REQUIRED for correctness, not just hygiene: Memory::resize only zero-fills bytes grown past buffer.len(), so handing a non-empty buffer to the next tx would expose stale data from the previous one (a consensus bug). Capacity is kept so the grown allocation is reused.

Source

pub fn next_memory(&self) -> Memory

Gets the Memory for the next children callframe.

Source

pub fn clean_from_base(&self)

Cleans the memory from base onwards, this must be used in callframes when handling returns.

On the callframe that is about to be dropped.

Source

pub fn len(&self) -> usize

Returns the len of the current memory, from the current base.

Source

pub fn is_empty(&self) -> bool

Source

pub fn live_bytes(&self) -> Vec<u8>

Returns a copy of the live byte slice for this frame (from current_base to current_base + len). Used by the struct-log tracer for memory capture.

Source

pub fn resize(&mut self, new_memory_size: usize) -> Result<(), VMError>

Resizes the from the current base to fit the memory specified at new_memory_size.

Note: new_memory_size is increased to the next 32 byte multiple.

Source

pub fn load_range( &mut self, offset: usize, size: usize, ) -> Result<Bytes, VMError>

Load size bytes from the given offset. Returning a Bytes.

Source

pub fn with_range<R>( &mut self, offset: usize, size: usize, f: impl FnOnce(&[u8]) -> R, ) -> Result<R, VMError>

Borrow size bytes from the given offset and pass them to f, without allocating a Bytes copy of the range.

load_range reads through self.buffer.borrow(), whose Ref guard cannot outlive this call — so a -> &[u8] accessor can’t be written. Callers that only need to read the range (e.g. hashing) take the borrow via this closure instead. Semantics match load_range exactly, including zero-padding reads past the current length (handled by resize).

Source

pub fn load_range_const<const N: usize>( &mut self, offset: usize, ) -> Result<[u8; N], VMError>

Load N bytes from the given offset.

Source

pub fn load_word(&mut self, offset: usize) -> Result<U256, VMError>

Load a word from at the given offset.

Source

pub fn store_data(&mut self, offset: usize, data: &[u8]) -> Result<(), VMError>

Stores the given data at the given offset.

Source

pub fn store_data_zero_padded( &mut self, offset: usize, data: &[u8], total_size: usize, ) -> Result<(), VMError>

Stores data and zero-pads up to total_size at the given offset.

Source

pub fn store_word(&mut self, offset: usize, word: U256) -> Result<(), VMError>

Stores a word at the given offset, resizing memory if needed.

Source

pub fn copy_within( &mut self, from_offset: usize, to_offset: usize, size: usize, ) -> Result<(), VMError>

Copies memory within 2 offsets. Like a memmove.

Resizes if needed, because one can copy from “expanded memory”, which is initialized with zeroes.

Source

pub fn store_zeros(&mut self, offset: usize, size: usize) -> Result<(), VMError>

Trait Implementations§

Source§

impl Clone for Memory

Source§

fn clone(&self) -> Memory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Memory

Source§

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

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

impl Default for Memory

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Memory

§

impl !Send for Memory

§

impl !Sync for Memory

§

impl !UnwindSafe for Memory

§

impl Freeze for Memory

§

impl Unpin for Memory

§

impl UnsafeUnpin for Memory

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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, U> ExactFrom<T> for U
where U: TryFrom<T>,

Source§

fn exact_from(value: T) -> U

Source§

impl<T, U> ExactInto<U> for T
where U: ExactFrom<T>,

Source§

fn exact_into(self) -> U

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T, U> OverflowingInto<U> for T
where U: OverflowingFrom<T>,

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T, U> RoundingInto<U> for T
where U: RoundingFrom<T>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> SaturatingInto<U> for T
where U: SaturatingFrom<T>,

Source§

impl<T> ToDebugString for T
where T: Debug,

Source§

fn to_debug_string(&self) -> String

Returns the String produced by Ts Debug implementation.

§Examples
use malachite_base::strings::ToDebugString;

assert_eq!([1, 2, 3].to_debug_string(), "[1, 2, 3]");
assert_eq!(
    [vec![2, 3], vec![], vec![4]].to_debug_string(),
    "[[2, 3], [], [4]]"
);
assert_eq!(Some(5).to_debug_string(), "Some(5)");
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T, U> WrappingInto<U> for T
where U: WrappingFrom<T>,

Source§

fn wrapping_into(self) -> U