Struct ContentStore 

pub struct ContentStore { /* private fields */ }

An app’s handle to binary content: cheap to clone, passed to whatever needs it.

Implementations

impl ContentStore

pub fn new(backend: impl ContentBackend + 'static) -> ContentStore

A store over backend.

pub fn from_backend(backend: Arc<dyn ContentBackend>) -> ContentStore

A store over a shared backend.

pub fn memory() -> ContentStore

Content that lives and dies with this handle and its clones: tests, headless tools.

pub fn device() -> Option<ContentStore>

The device content store, when the launcher handed this process its capability. Every returned store shares the one connection. Returns None on hosts without device transport or when the device feature is disabled; no storage fallback is opened.

pub fn in_dir(root: impl Into<PathBuf>) -> ContentStore

Content in the directory root, created on first write.

pub fn for_app() -> ContentStore

The store an app uses unless it is handed another: the device content store when the launcher handed this process its capability (ContentStore::device), otherwise the session’s shared directory when the host names one ([SHARED_STORE_ENV]), otherwise, where files have no native path (a browser page), the profile’s app files ([FilesBackend]), otherwise tilo/content in the user’s data directory. Content an earlier version kept in the cache directory (tilo/blobs) still reads. With no usable directory at all, content is kept in memory.

pub fn put(&self, bytes: &[u8]) -> Result<String, ContentError>

Store bytes, returning their address. The media type is sniffed from the content.

Errors

See [ContentBackend::put].

pub fn put_reader( &self, reader: &mut dyn Read, mime: &str, ) -> Result<Stored, ContentError>

Store everything reader yields without holding it in memory: the device store sends it to the daemon one runtime_fs::blobs::MAX_PUT_CHUNK at a time.

Errors

See [ContentBackend::put].

pub fn put_inputs(&self, inputs: &ContentInputs) -> Result<(), ContentError>

Store every input inputs collected (an import’s images, say).

Errors

The first refusal; inputs stored before it stay stored.

pub fn read(&self, hash: &str) -> Option<Vec<u8>>

The verified content at hash, or None when it is not here (or not intact).

pub fn open(&self, hash: &str) -> Option<Box<dyn Read + Send>>

A streaming, verifying read of the content at hash; see [ContentReader].

pub fn has(&self, hash: &str) -> bool

Whether the content at hash is here.

pub fn state(&self, hash: &str) -> ContentState

Where the content at hash has got to.

pub fn shared(&self) -> bool

Whether content stored here reaches the app’s other devices and collaborators; see [ContentBackend::shared].

pub fn collect_unreferenced( &self, live: &BTreeSet<String>, ) -> Result<Collected, ContentError>

Remove every item not named in live; see [ContentBackend::collect_unreferenced].

Errors

See [ContentBackend::collect_unreferenced].

Trait Implementations

impl Clone for ContentStore

fn clone(&self) -> ContentStore

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ContentSource for ContentStore

fn content(&self, hash: &str) -> Option<Cow<'_, [u8]>>

The bytes at hash, if this source has them.

impl Debug for ContentStore

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

Formats the value using the given formatter.