Skip to main content

SharedContainerLayout

Struct SharedContainerLayout 

Source
pub struct SharedContainerLayout { /* private fields */ }
Expand description

Per-container directory layout within the shared filesystem.

Represents the directory structure for a single container:

{root}/                    # shared/containers/{cid}/
├── overlayfs/
│   ├── diff/              # Image layers (lower dirs for overlayfs)
│   ├── upper/             # Overlayfs upper (writable layer)
│   └── work/              # Overlayfs work directory
├── rootfs/                # All rootfs strategies mount here
└── volumes/               # User volumes (virtiofs mounts)
    ├── {volume-name-1}/
    └── {volume-name-2}/

Implementations§

Source§

impl SharedContainerLayout

Source

pub fn new(root: impl Into<PathBuf>) -> Self

Create a container layout with the given root path.

Source

pub fn root(&self) -> &Path

Root directory of this container: shared/containers/{cid}

Source

pub fn overlayfs_dir(&self) -> PathBuf

Overlayfs directory: {root}/overlayfs

Source

pub fn upper_dir(&self) -> PathBuf

Upper directory: {root}/overlayfs/upper

Writable layer for overlayfs.

Source

pub fn work_dir(&self) -> PathBuf

Work directory: {root}/overlayfs/work

Overlayfs work directory.

Source

pub fn diff_dir(&self) -> PathBuf

Diff directory: {root}/overlayfs/diff

Contains image layers (lower dirs for overlayfs).

Source

pub fn rootfs_dir(&self) -> PathBuf

Rootfs directory: {root}/rootfs

All rootfs strategies (merged, overlayfs, disk image) mount here. Guest bind mounts /run/boxlite/{cid}/rootfs/ to this location.

Source

pub fn volumes_dir(&self) -> PathBuf

Volumes directory: {root}/volumes

Base directory for user volume mounts.

Source

pub fn volume_dir(&self, volume_name: &str) -> PathBuf

Specific volume directory: {root}/volumes/{volume_name}

Convention-based path for a specific user volume. Both host and guest use this to construct volume mount paths.

Source

pub fn layers_dir(&self) -> PathBuf

Layers directory: {root}/layers

Source directory for image layers (virtiofs mount point). Guest bind-mounts from here to diff_dir for overlayfs.

Source

pub fn prepare(&self) -> Result<()>

Prepare container directories.

Trait Implementations§

Source§

impl Clone for SharedContainerLayout

Source§

fn clone(&self) -> SharedContainerLayout

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SharedContainerLayout

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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