Skip to main content

PendingSnapshot

Struct PendingSnapshot 

Source
pub struct PendingSnapshot<'a> { /* private fields */ }
Expand description

A snapshot being written, not yet part of the catalog.

Firecracker writes into Self::dir, a staging directory that is deliberately outside the catalog’s namespace, and Self::commit writes meta.json there and renames the whole directory into place. That single atomic publish is what lets every reader assume a catalogued directory has a readable record: a snapshot is either complete or not there at all.

Dropping without committing removes the staging directory, so a failed checkpoint leaves neither a record-less entry nor a partial vmstate/mem behind. A crash leaves the staging directory, which SnapshotCatalog::sweep_incomplete reclaims on the next start.

Implementations§

Source§

impl PendingSnapshot<'_>

Source

pub fn id(&self) -> &str

Identifier the snapshot will carry once published.

Source

pub fn dir(&self) -> PathBuf

Staging directory to write vmstate and mem into.

Source

pub fn commit(self, draft: SnapshotDraft) -> Result<SnapshotMeta, SnapshotError>

Publish the snapshot: write the record, then rename it into the catalog.

The mem file is recorded when the staging directory actually holds one (diff snapshots and jailer moves may not produce it).

Trait Implementations§

Source§

impl Drop for PendingSnapshot<'_>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for PendingSnapshot<'a>

§

impl<'a> RefUnwindSafe for PendingSnapshot<'a>

§

impl<'a> Send for PendingSnapshot<'a>

§

impl<'a> Sync for PendingSnapshot<'a>

§

impl<'a> Unpin for PendingSnapshot<'a>

§

impl<'a> UnsafeUnpin for PendingSnapshot<'a>

§

impl<'a> UnwindSafe for PendingSnapshot<'a>

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

Source§

type Output = T

Should always be Self
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