Struct MockAlloc

pub struct MockAlloc { /* private fields */ }

An alloc is a specific allocation, returned by an Allocator.

Implementations

impl MockAlloc

pub fn checkpoint(&mut self)

Validate that all current expectations for all methods have been satisfied, and discard them.

pub fn new() -> Self

Create a new mock object with no expectations.

This method will not be generated if the real struct already has a new method. However, it will be generated if the struct implements a trait with a new method. The trait’s new method can still be called like <MockX as TraitY>::new

impl MockAlloc

pub fn expect_next(&mut self) -> &mut Expectation

Create an Expectation for mocking the next method

pub fn expect_extent(&mut self) -> &mut Expectation

Create an Expectation for mocking the extent method

pub fn expect_shape(&mut self) -> &mut Expectation

Create an Expectation for mocking the shape method

pub fn expect_world_id(&mut self) -> &mut Expectation

Create an Expectation for mocking the world_id method

pub fn expect_transport(&mut self) -> &mut Expectation

Create an Expectation for mocking the transport method

pub fn expect_stop(&mut self) -> &mut Expectation

Create an Expectation for mocking the stop method

pub fn expect_stop_and_wait(&mut self) -> &mut Expectation

Create an Expectation for mocking the stop_and_wait method

Trait Implementations

impl Alloc for MockAlloc

An alloc is a specific allocation, returned by an Allocator.

fn next<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<ProcState>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Return the next proc event. None indicates that there are no more events, and that the alloc is stopped.

fn extent(&self) -> &Extent

The shape of the alloc.

fn shape(&self) -> Shape

The shape of the alloc. (Deprecated.)

fn world_id(&self) -> &WorldId

The world id of this alloc, uniquely identifying the alloc. Note: This will be removed in favor of a different naming scheme, once we exise “worlds” from hyperactor core.

fn transport(&self) -> ChannelTransport

The channel transport used the procs in this alloc.

fn stop<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AllocatorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop this alloc, shutting down all of its procs. A clean shutdown should result in Stop events from all allocs, followed by the end of the event stream.

fn stop_and_wait<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), AllocatorError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Stop this alloc and wait for all procs to stop. Call will block until all ProcState events have been drained.

impl Debug for MockAlloc

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

Formats the value using the given formatter.

impl Default for MockAlloc

fn default() -> Self

Returns the “default value” for a type.