cubecl-environment 0.11.0-pre.2

Environment compatibility layer for CubeCL: sync primitives, futures, streams, config and persistence across std, no-std, wasm and tokio
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use alloc::string::String;
use alloc::vec::Vec;

use crate::bytes::Bytes;

/// A read-only set of pre-computed cache entries shipped with an application.
///
/// Lookups use the same two coordinates as the local cache: the namespace the
/// persistence layer computes (`<name>/<version>/<segments>`) and the
/// serialized key bytes. A bundle therefore needs no path rewriting, and
/// several bundles in different formats can be installed side by side.
///
/// A bundle is an *import* format, not a runtime one: [`import`](super::import)
/// copies its entries into the local storage once, and nothing consults it
/// afterwards. Runtime lookups only ever touch
/// [`Storage`](crate::persistence::Storage).
///
/// Reads hand back [`Bytes`], which a format can serve as a zero-copy window
/// into its own storage: an embedded bundle returns a view of its blob rather
/// than a copy.
///
/// All methods degrade silently: a miss on any failure.
pub trait Bundle: Send + Sync + core::fmt::Debug {
    /// The value stored under `key` in `namespace`.
    fn get(&self, namespace: &str, key: &[u8]) -> Option<Bytes>;

    /// Visits every entry of `namespace`.
    fn scan(&self, namespace: &str, visit: &mut dyn FnMut(&[u8], &[u8]));

    /// Every namespace the bundle holds entries for.
    fn namespaces(&self) -> Vec<String>;

    /// Human-readable origin for log messages.
    fn describe(&self) -> String;
}