Skip to main content

OciCommand

Enum OciCommand 

Source
pub(crate) enum OciCommand {
Show 13 variants ImportLayer { digest: OciDigest, name: Option<String>, }, LsLayer { name: OciDigest, }, Dump { config_opts: OCIConfigFilesystemOptions, }, Pull { image: String, name: Option<String>, bootable: bool, local_fetch: LocalFetchCli, }, ListImages { json: bool, }, Inspect { image: OciReference, manifest: bool, config: bool, }, Tag { manifest_digest: OciDigest, name: String, }, Untag { name: String, }, LayerInspect { layer: OciDigest, dumpfile: bool, json: bool, }, Mount { image: String, mountpoint: String, bootable: bool, }, ComputeId { config_opts: OCIConfigFilesystemOptions, }, PrepareBoot { config_opts: OCIConfigOptions, bootdir: PathBuf, entry_id: Option<String>, cmdline: Vec<String>, }, Fsck { image: Option<String>, json: bool, },
}

Variants§

§

ImportLayer

Import a tar layer as a splitstream in the repository

Fields

§digest: OciDigest

Layer content digest, e.g. sha256:a1b2c3…

§name: Option<String>

Optional human-readable name for the layer

§

LsLayer

List the contents of a stored tar layer

Fields

§name: OciDigest

Layer content digest, e.g. sha256:a1b2c3…

§

Dump

Dump the rootfs of a stored OCI image as a composefs dumpfile to stdout

The image can be specified by ref name or @digest: cfsctl oci dump myimage:latest cfsctl oci dump @sha256:a1b2c3…

Fields

§

Pull

Pull an OCI image into the repository

Prints the config stream digest and verity of the stored manifest.

Fields

§image: String

Source image reference, as accepted by skopeo

§name: Option<String>

Tag name to assign to the pulled image (defaults to the image reference)

§bootable: bool

Also generate a bootable EROFS image from the pulled OCI image

§local_fetch: LocalFetchCli

Controls whether containers-storage: references use the native import path with zero-copy reflink/hardlink support.

§

ListImages

List all tagged OCI images in the repository

Fields

§json: bool

Output as JSON array

§

Inspect

Show information about an OCI image

The image can be specified by ref name or @digest: cfsctl oci inspect myimage:latest cfsctl oci inspect @sha256:a1b2c3…

By default, outputs JSON with manifest, config, and referrers. Use –manifest or –config to output just that raw JSON.

Fields

§image: OciReference

Ref name (e.g. myimage:latest) or @digest (e.g. @sha256:a1b2c3…)

§manifest: bool

Output only the raw manifest JSON (as originally stored)

§config: bool

Output only the raw config JSON (as originally stored)

§

Tag

Tag an image with a new name

Example: cfsctl oci tag sha256:a1b2c3… myimage:latest

Fields

§manifest_digest: OciDigest

Manifest digest, e.g. sha256:a1b2c3…

§name: String

Tag name to assign (must not contain ‘@’)

§

Untag

Remove a tag from an image

Fields

§name: String

Tag name to remove

§

LayerInspect

Inspect a stored layer

By default, outputs the raw tar stream to stdout. Use –dumpfile for composefs dumpfile format, or –json for metadata.

Fields

§layer: OciDigest

Layer diff_id, e.g. sha256:a1b2c3…

§dumpfile: bool

Output as composefs dumpfile format (one entry per line)

§json: bool

Output layer metadata as JSON

§

Mount

Mount an OCI image’s composefs EROFS at the given mountpoint

Fields

§image: String

Image reference (tag name or manifest digest)

§mountpoint: String

Target mountpoint

§bootable: bool

Mount the bootable variant instead of the regular EROFS image

§

ComputeId

Compute the composefs image ID of a stored OCI image’s rootfs

The image can be specified by ref name or @digest: cfsctl oci compute-id myimage:latest cfsctl oci compute-id @sha256:a1b2c3…

Fields

§

PrepareBoot

Create the composefs image of the rootfs of a stored OCI image, perform bootable transformation, commit it to the repo, then configure boot for the image by writing new boot resources and bootloader entries to boot partition. Performs state preparation for composefs-setup-root consumption as well. Note that state preparation here is not suitable for consumption by bootc.

Fields

§config_opts: OCIConfigOptions
§bootdir: PathBuf

boot partition mount point

§entry_id: Option<String>

Boot entry identifier to use. By default uses ID provided by the image or kernel version

§cmdline: Vec<String>

additional kernel command line

§

Fsck

Check integrity of OCI images in the repository

Verifies manifest and config content digests, layer references, seal consistency, and delegates to the underlying repository fsck for object integrity and splitstream validation.

Fields

§image: Option<String>

Check only the named image instead of all tagged images

§json: bool

Output results as JSON (always exits 0 unless the check itself fails)

Trait Implementations§

Source§

impl Debug for OciCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for OciCommand

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

impl Subcommand for OciCommand

Source§

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut] Read more
Source§

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut] Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> MaybeSend for T
where T: Send,