Skip to main content

StandaloneCanisterRecipe

Struct StandaloneCanisterRecipe 

Source
pub struct StandaloneCanisterRecipe<B> { /* private fields */ }
Expand description

Snapshot-only recipe for one caller-built, installed canister.

Use with super::CachedPocketIcBaselinePool. The baseline metadata is the installed canister ID; calls go through the baseline’s borrowed PocketIC. The builder owns initialization and readiness before capture and must produce the same topology and seeded state for every slot of this recipe. It returns io::Result<StandaloneCanisterFixture>; build errors retain their original cause and are reported at the pool’s build stage, without invoking capture.

Only the captured canister is restored. Time, other canisters, pending work and external resources are not reset. Use a custom recipe or a fresh instance when those mutations matter. Funding is applied immediately before restore. This recipe stops/drains its single canister before capture and warm restore, then starts it at readiness. Automatic progress must remain disabled. Non-transport restore failures are fatal: the pool discards the affected baseline before returning the error. Dead transport permits one recovery build.

Implementations§

Source§

impl<B> StandaloneCanisterRecipe<B>

Source

pub fn new(funding: SnapshotRestoreFunding, build: B) -> Self

Describe a single-canister recipe without invoking its builder.

Static suites can initialize the recipe and pool with std::sync::LazyLock.

Trait Implementations§

Source§

impl<B> PocketIcBaselineRecipe for StandaloneCanisterRecipe<B>
where B: Fn() -> Result<StandaloneCanisterFixture> + Send + Sync + 'static,

Source§

type Metadata = Principal

Metadata retained beside every baseline owned by this recipe.
Source§

type Error = Error

Structured caller error shared by recipe lifecycle stages.
Source§

fn reset_requirements(&self) -> &ResetRequirements

Reset guarantees required before an existing slot may be reused.
Source§

fn build(&self) -> Result<CachedPocketIcBaseline<Principal>, Error>

Construct and capture one complete baseline. Stop/drain the complete snapshot set before capture, then start it after the complete set is captured and ready. Automatic progress stays disabled. Read more
Source§

fn reset_non_snapshot_state( &self, _baseline: &CachedPocketIcBaseline<Principal>, ) -> Result<ResetReceipt, Error>

Reset state not covered by canister snapshots. Read more
Source§

fn prepare_restore( &self, baseline: &CachedPocketIcBaseline<Principal>, ) -> Result<(), Error>

Admit recipe-specific preconditions before the pool restores snapshots. Read more
Source§

fn drive_to_readiness( &self, baseline: &CachedPocketIcBaseline<Principal>, ) -> Result<(), Error>

Drive the topology to the recipe’s readiness boundary. Successful completion permits final invariant validation. Restart the complete stopped set here, after canonical restore and the non-snapshot reset have succeeded. Never restart a partially restored set. Read more
Source§

fn validate( &self, _baseline: &CachedPocketIcBaseline<Principal>, _preparation: &PreparedBaseline, ) -> Result<(), Error>

Validate the same baseline invariants after build and restore. Success admits this pool-owned recipe’s baseline for leasing. Read more
Source§

fn classify_failure( &self, _stage: BaselinePreparationStage, error: &(dyn Error + 'static), ) -> FailureDisposition

Classify a restored-slot recipe failure as fatal or rebuildable.

Auto Trait Implementations§

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> 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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