#container-image #oci #container #docker #podman #image-processing #opencontainers

ocidir

A Rust library for reading and writing OCI (opencontainers) layout directories

5 unstable releases

0.3.1 Sep 20, 2024
0.3.0 Sep 13, 2024
0.2.1 Aug 16, 2024
0.2.0 Jul 23, 2024
0.1.0 Jun 2, 2024

#303 in Unix APIs

Download history 211/week @ 2024-08-01 332/week @ 2024-08-08 507/week @ 2024-08-15 223/week @ 2024-08-22 453/week @ 2024-08-29 307/week @ 2024-09-05 605/week @ 2024-09-12 559/week @ 2024-09-19 513/week @ 2024-09-26 295/week @ 2024-10-03 328/week @ 2024-10-10 530/week @ 2024-10-17 320/week @ 2024-10-24 543/week @ 2024-10-31 547/week @ 2024-11-07 503/week @ 2024-11-14

1,988 downloads per month
Used in 5 crates (4 directly)

MIT/Apache

34KB
672 lines

ocidir

Crates.io

docs.rs

Read and write to OCI image layout directories

This library contains medium and low-level APIs for working with OCI images, which are basically a directory with blobs and JSON files for metadata.

Dependency on cap-std

This library makes use of cap-std to operate in a capability-oriented fashion. In practice, the code in this project is well tested and would not traverse outside its own path root. However, using capabilities is a generally good idea when operating in the container ecosystem, in particular when actively processing tar streams.

Examples

To access an existing OCI directory:

# use ocidir::cap_std;
# use anyhow::{anyhow, Result};
# fn main() -> anyhow::Result<()> {
let d = cap_std::fs::Dir::open_ambient_dir("/path/to/ocidir", cap_std::ambient_authority())?;
let d = ocidir::OciDir::open(&d)?;
println!("{:?}", d.read_index()?.ok_or_else(|| anyhow!("missing Image Index"))?);
# Ok(())
# }

Dependencies

~11–22MB
~364K SLoC