Struct BuildLayer 

pub struct BuildLayer { /* private fields */ }

A staged build layer: the disposable overlay upper an increment was installed into, removed when the handle is dropped.

Returned by Debian::stage_layer. Returned by Alpine::stage_layer. Returned by Gentoo::stage_layer.

The upper it owns is the writable layer of a build root — the caller roots a cage on overlay_rootfs(base, layer.path()) to build against the merged base + increment view. Dropping the handle removes the upper and the overlay’s work directory beside it, reverting the increment and leaving the base pristine; the base is a separate directory the handle never touches.

Keep the handle alive for as long as the build root is in use, and drop it to dispose of the increment. The removal is best-effort at drop time — a drop cannot report an error — so a caller that must observe a disposal failure removes the upper directory explicitly through provision::remove before dropping the handle, which then finds nothing to remove.

Implementations

impl BuildLayer

pub fn path(&self) -> &Path

The overlay upper directory, the build root’s writable layer.

Pass it as the upper of CageBuilder::overlay_rootfs, with the base as the lower, to root a build cage on the merged view.

Trait Implementations

impl Debug for BuildLayer

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

Formats the value using the given formatter.

impl Drop for BuildLayer

fn drop(&mut self)

Executes the destructor for this type.

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.