Struct netstack3_base::testutil::FakeBindingsCtx

pub struct FakeBindingsCtx<TimerId, Event: Debug, State, FrameMeta> {
    pub rng: FakeCryptoRng,
    pub timers: FakeTimerCtx<TimerId>,
    pub events: FakeEventCtx<Event>,
    pub frames: FakeFrameCtx<FrameMeta>,
    pub state: State,
}

A test helper used to provide an implementation of a bindings context.

Fields

rng: FakeCryptoRng

Provides RngContext.

timers: FakeTimerCtx<TimerId>

Provides TimerContext.

events: FakeEventCtx<Event>

Provides EventContext.

frames: FakeFrameCtx<FrameMeta>

Provides [SendFrameContext].

state: State

Generic state used by specific tests.

Implementations

impl<TimerId, Event: Debug, State, FrameMeta> FakeBindingsCtx<TimerId, Event, State, FrameMeta>

pub fn seed_rng(&mut self, seed: u128)

Seed the testing RNG with a specific value.

pub fn take_events(&mut self) -> Vec<Event>

Takes all the accumulated events from the FakeEventCtx.

Trait Implementations

impl<Id, Event: Debug, State, FrameMeta> AsMut<FakeTimerCtx<Id>> for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn as_mut(&mut self) -> &mut FakeTimerCtx<Id>

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

impl<Id, Event: Debug, State, FrameMeta> AsRef<FakeInstantCtx> for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn as_ref(&self) -> &FakeInstantCtx

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

impl<Id, Event: Debug, State, FrameMeta> AsRef<FakeTimerCtx<Id>> for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn as_ref(&self) -> &FakeTimerCtx<Id>

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

impl<TimerId, Event: Debug, State, FrameMeta> ContextProvider for FakeBindingsCtx<TimerId, Event, State, FrameMeta>

type Context = FakeBindingsCtx<TimerId, Event, State, FrameMeta>

The context provided by this ContextProvider.

fn context(&mut self) -> &mut Self::Context

Gets a mutable borrow to this context.

impl<TimerId, Event: Debug, State: Default, FrameMeta> Default for FakeBindingsCtx<TimerId, Event, State, FrameMeta>

fn default() -> Self

Returns the “default value” for a type.

impl<Id, Event: Debug, State, FrameMeta> DeferredResourceRemovalContext for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn defer_removal<T: Send + 'static>( &mut self, receiver: Self::ReferenceReceiver<T> )

Defers the removal of some resource T to bindings.

fn defer_removal_result<T: Send + 'static>( &mut self, result: RemoveResourceResultWithContext<T, Self> )

A shorthand for [defer_removal] that takes a ReferenceReceiver from the Deferred variant of a RemoveResourceResult.

impl<Id, Event: Debug, State, FrameMeta> EventContext<Event> for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn on_event(&mut self, event: Event)

Handles event.

impl<Id, Event: Debug, State, FrameMeta> ReferenceNotifiers for FakeBindingsCtx<Id, Event, State, FrameMeta>

type ReferenceReceiver<T: 'static> = Infallible

The receiver for shared reference destruction notifications.

type ReferenceNotifier<T: Send + 'static> = Infallible

The notifier for shared reference destruction notifications.

fn new_reference_notifier<T: Send + 'static>( debug_references: DynDebugReferences ) -> (Self::ReferenceNotifier<T>, Self::ReferenceReceiver<T>)

Creates a new Notifier/Receiver pair for T.

impl<TimerId, Event: Debug, State, FrameMeta> RngContext for FakeBindingsCtx<TimerId, Event, State, FrameMeta>

type Rng<'a> = FakeCryptoRng where Self: 'a

The random number generator (RNG) provided by this RngContext.

fn rng(&mut self) -> Self::Rng<'_>

Gets the random number generator (RNG).

impl<Id: Debug + PartialEq + Clone + Send + Sync, Event: Debug, State, FrameMeta> TimerBindingsTypes for FakeBindingsCtx<Id, Event, State, FrameMeta>

type Timer = <FakeTimerCtx<Id> as TimerBindingsTypes>::Timer

State for a timer created through TimerContext.

type DispatchId = <FakeTimerCtx<Id> as TimerBindingsTypes>::DispatchId

The type used to dispatch fired timers from bindings to core.

impl<Id: Debug + PartialEq + Clone + Send + Sync, Event: Debug, State, FrameMeta> TimerContext for FakeBindingsCtx<Id, Event, State, FrameMeta>

fn new_timer(&mut self, id: Self::DispatchId) -> Self::Timer

Creates a new timer that dispatches id back to core when fired.

fn schedule_timer_instant( &mut self, time: Self::Instant, timer: &mut Self::Timer ) -> Option<Self::Instant>

Schedule a timer to fire at some point in the future. Returns the previously scheduled instant, if this timer was scheduled.

fn cancel_timer(&mut self, timer: &mut Self::Timer) -> Option<Self::Instant>

Cancel a timer.

fn scheduled_instant(&self, timer: &mut Self::Timer) -> Option<Self::Instant>

Get the instant a timer will fire, if one is scheduled.

fn schedule_timer( &mut self, duration: Duration, timer: &mut Self::Timer ) -> Option<Self::Instant>

Like [schedule_timer_instant] but schedules a time for duration in the future.

impl<Id, Event: Debug, State, FrameMeta> TracingContext for FakeBindingsCtx<Id, Event, State, FrameMeta>

type DurationScope = ()

The scope of a trace duration.

fn duration(&self, _: &'static CStr)

Writes a duration event which ends when the returned scope is dropped.

impl<TimerId, Event: Debug, State, FrameMeta> WithFakeTimerContext<TimerId> for FakeBindingsCtx<TimerId, Event, State, FrameMeta>

fn with_fake_timer_ctx<O, F: FnOnce(&FakeTimerCtx<TimerId>) -> O>( &self, f: F ) -> O

Calls the callback with a borrow of FakeTimerCtx.

fn with_fake_timer_ctx_mut<O, F: FnOnce(&mut FakeTimerCtx<TimerId>) -> O>( &mut self, f: F ) -> O

Calls the callback with a mutable borrow of FakeTimerCtx.