Struct BlobStore 

pub struct BlobStore { /* private fields */ }

Implementations

impl BlobStore

pub fn new(protocol: &BlobsProtocol) -> Self

pub fn new_with_address_lookup( protocol: &BlobsProtocol, address_lookup: MemoryLookup, ) -> Self

pub const fn inner(&self) -> &BlobApi

pub fn reader(&self, hash: impl Into<Hash>) -> BlobReader

Create a reader for the given hash.

The reader implements tokio::io::AsyncRead and tokio::io::AsyncSeek, allowing O(1)-memory streaming to any sink.

pub async fn add_bytes(&self, data: impl AsRef<[u8]>) -> Result<Hash>

Errors

Returns an error if the blob fails to be added to the store.

pub async fn add_file(&self, path: impl AsRef<Path>) -> Result<Hash>

Errors

Returns an error if the file fails to be read or added to the store.

pub async fn add_file_ref(&self, path: impl AsRef<Path>) -> Result<Hash>

Add a file using a reference to its original path instead of copying its contents into the blob store.

The source file must remain available and unchanged for as long as the blob store may need to read this blob.

Errors

Returns an error if the file fails to be read or added to the store.

pub async fn export_to_path( &self, hash: Hash, destination: impl AsRef<Path>, ) -> Result<u64>

Export a complete blob to a temporary or caller-managed path.

Uses ExportMode::Copy — the blob stays in the store and a copy (or CoW reflink) is written to destination.

Errors

Returns an error if the blob cannot be read or written.

pub async fn export_to_path_with_mode( &self, hash: Hash, destination: impl AsRef<Path>, mode: ExportMode, ) -> Result<u64>

Export a complete blob with a specific ExportMode.

ExportMode::TryReference moves the blob’s internal file to destination and updates the store to track it externally, avoiding a copy. ExportMode::Copy leaves the blob in the store and writes a copy (or CoW reflink) to destination.

Errors

Returns an error if the blob cannot be read or written.

pub async fn has(&self, hash: Hash) -> Result<bool>

Errors

Returns an error if the store cannot be queried.

pub async fn stat(&self, hash: Hash) -> Result<BlobStatus>

Get metadata (size) for a blob.

Errors

Returns an error if the blob is not found or the store cannot be queried.

pub async fn get(&self, hash: Hash) -> Result<Bytes>

Errors

Returns an error if the blob cannot be found or read.

pub fn ticket(&self, endpoint: &Endpoint, hash: Hash) -> BlobTicket

pub fn ticket_for_addr(&self, addr: EndpointAddr, hash: Hash) -> BlobTicket

pub async fn pin(&self, name: impl AsRef<str>, hash: Hash) -> Result<()>

Pin a blob with a durable named tag so garbage collection cannot remove it.

Errors

Returns an error if the tag cannot be written.

pub async fn unpin(&self, name: impl AsRef<str>) -> Result<()>

Remove a durable pin from a blob.

Errors

Returns an error if the tag cannot be removed.

pub async fn is_pinned(&self, name: impl AsRef<str>, hash: Hash) -> Result<bool>

Errors

Returns an error if the pin cannot be queried.

pub async fn list_hashes(&self) -> Result<Vec<Hash>>

List all complete blobs currently in the store.

Errors

Returns an error if the store cannot be queried.

pub async fn list_pins( &self, prefix: impl AsRef<[u8]>, ) -> Result<Vec<(String, Hash)>>

List named pins whose names start with prefix.

Errors

Returns an error if the store cannot be queried.

pub async fn fetch( &self, endpoint: &Endpoint, ticket: &BlobTicket, ) -> Result<()>

Errors

Returns an error if the blob cannot be fetched from the remote endpoint.

pub async fn download_with_network( &self, endpoint: &Endpoint, ticket: &BlobTicket, ctx: &NetworkContext, ) -> Result<()>

Fetch a blob with network access control gating.

Checks via NetworkContext that the local node can access the blob through at least one network membership before downloading.

Errors

Returns AccessDenied if the blob is not associated with any network the local node belongs to. Returns other errors if the fetch itself fails.

pub async fn force_fetch( &self, endpoint: &Endpoint, ticket: &BlobTicket, ) -> Result<()>

Force-fetch a blob from a remote peer, re-downloading even if the blob is already present locally. Uses iroh-blobs’ low-level execute_get API which does not check local availability.

Errors

Returns an error if the connection or download fails.

pub async fn force_fetch_from_peer( &self, endpoint: &Endpoint, peer: &PublicKey, hash: Hash, ) -> Result<()>

Force-fetch a blob from a known peer, connecting by public key alone.

Errors

Returns an error if the connection or download fails.

Trait Implementations

impl Clone for BlobStore

fn clone(&self) -> BlobStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.