Skip to main content

Crate composefs_ctl

Crate composefs_ctl 

Source
Expand description

Library for cfsctl command line utility

This crate also re-exports all composefs-rs library crates, so downstream consumers can take a single dependency on cfsctl instead of listing each crate individually.

use composefs_ctl::composefs::repository::Repository;
use composefs_ctl::composefs::fsverity::Sha256HashValue;

let repo = Repository::<Sha256HashValue>::open_path(
    rustix::fs::CWD,
    "/nonexistent",
);
assert!(repo.is_err());

Re-exportsΒ§

pub use composefs;
pub use composefs_boot;
pub use composefs_oci;

StructsΒ§

App
cfsctl
FsReadOptions πŸ”’
Common options for reading a filesystem from a path
FsckJsonOutput πŸ”’
JSON output wrapper for cfsctl fsck --json.
OCIConfigFilesystemOptions πŸ”’
Common options for operations using OCI config manifest streams that may transform the image rootfs
OCIConfigOptions πŸ”’
Common options for operations using OCI config manifest streams
OciFsckJsonOutput πŸ”’
JSON output wrapper for cfsctl oci fsck --json.

EnumsΒ§

Command πŸ”’
HashType
The Hash algorithm used for FsVerity computation
LocalFetchCli πŸ”’
CLI representation of [composefs_oci::LocalFetchOpt].
OciCommand πŸ”’
OciReference πŸ”’
A reference to an OCI image: either a content digest or a named ref.

FunctionsΒ§

dump_file_impl πŸ”’
load_filesystem_from_oci_image πŸ”’
load_filesystem_from_ondisk_fs πŸ”’
open_repo
Open a repo, auto-upgrading old-format repos unless --no-upgrade was passed.
resolve_hash_type πŸ”’
Determine the effective hash type for a repository.
resolve_oci_config πŸ”’
Resolve an OciReference to a config digest and optional verity.
resolve_oci_image πŸ”’
Resolve an OciReference to an [OciImage].
resolve_repo_path πŸ”’
Resolve the repository path from CLI args without opening it.
run_app
Top-level dispatch: handle init specially, otherwise open repo and run.
run_cmd_with_repo
Run with cmd
run_cmd_without_repo
Run commands that don’t require a repository.
run_from_iter
Acts as a proxy for the cfsctl CLI by executing the CLI logic programmatically
run_init πŸ”’
Handle cfsctl init
verity_opt πŸ”’