Struct EmbeddedBundle 

pub struct EmbeddedBundle { /* private fields */ }

A bundle held as one blob of bytes, embedded in the binary with include_bytes! or fetched at runtime.

This is the format for targets without a file system. The blob is held as shared Bytes, so a lookup hands back a zero-copy window into it rather than a copy: serving a compiled kernel costs a reference count, whatever its size.

Ignored rather than run: the bundle file is produced by cargo xtask bundle export --format flat, so there is none to include here.

use cubecl_environment::bundle::{self, EmbeddedBundle};

static BUNDLE: &[u8] = include_bytes!("../bundles/h100.ccb");

let bundle = EmbeddedBundle::from_static(BUNDLE).expect("valid bundle");
bundle::import(&bundle);

Implementations

impl EmbeddedBundle

pub fn open(bytes: Bytes) -> Result<Self, EmbeddedBundleError>

Reads a flat bundle, validating it once so that later lookups can’t fail.

The blob is shared on the way in so that lookups can return zero-copy windows into it.

pub fn from_static(blob: &'static [u8]) -> Result<Self, EmbeddedBundleError>

Reads a flat bundle embedded in the binary with include_bytes!.

With the shared-bytes feature the static blob is adopted as is, so the bundle occupies no heap at all. Without it, the bytes are copied once at startup.

pub fn metadata(&self) -> &[u8]

The opaque metadata blob, a JSON manifest when written by export.

pub fn manifest(&self) -> Result<BundleManifest, BundleError>

The bundle manifest, parsed from metadata and validated against the schema this build understands.

The flat format keeps the manifest out of the read path on purpose, so it is checked here rather than at open: a bundle whose manifest this build can’t read still serves its entries.

pub fn len(&self) -> usize

How many entries the bundle holds, across all namespaces.

pub fn is_empty(&self) -> bool

Whether the bundle holds no entries at all.

pub fn summary(&self) -> Vec<NamespaceSummary>

Entry count and total size per namespace, for reporting.

Trait Implementations

impl Bundle for EmbeddedBundle

fn get(&self, namespace: &str, key: &[u8]) -> Option<Bytes>

The value stored under key in namespace.

fn scan(&self, namespace: &str, visit: &mut dyn FnMut(&[u8], &[u8]))

Visits every entry of namespace.

fn namespaces(&self) -> Vec<String>

Every namespace the bundle holds entries for.

fn describe(&self) -> String

Human-readable origin for log messages.

impl Debug for EmbeddedBundle

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

Formats the value using the given formatter.