Skip to main content

Bundle

Struct Bundle 

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

OCI bundle representation.

A bundle encapsulates an OCI runtime configuration and its associated root filesystem.

Implementations§

Source§

impl Bundle

Source

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self>

Load an OCI bundle from a directory.

This reads and validates the config.json file and checks that the bundle structure is valid.

Source

pub fn create<P: AsRef<Path>>(path: P, spec: Spec) -> Result<Self>

Create a new bundle from an existing spec.

This creates the bundle directory structure and writes the config.json.

Source

pub fn create_default<P: AsRef<Path>>(path: P) -> Result<Self>

Create a bundle with default Linux configuration.

Source

pub fn path(&self) -> &Path

Get the bundle directory path.

Source

pub const fn spec(&self) -> &Spec

Get the OCI specification.

Source

pub const fn spec_mut(&mut self) -> &mut Spec

Get mutable reference to the OCI specification.

Source

pub fn config_path(&self) -> PathBuf

Get the config.json path.

Source

pub fn rootfs_path(&self) -> PathBuf

Get the root filesystem path.

Returns the resolved absolute path to the rootfs.

Source

pub fn rootfs_exists(&self) -> bool

Check if the rootfs exists.

Source

pub fn rootfs_readonly(&self) -> bool

Check if the rootfs is configured as read-only.

Source

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

Validate the bundle structure.

Source

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

Save any modifications to the spec back to config.json.

Source

pub fn update_spec(&mut self, spec: Spec) -> Result<()>

Update the spec and save.

Trait Implementations§

Source§

impl Clone for Bundle

Source§

fn clone(&self) -> Bundle

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 Bundle

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