Struct Blobs

pub struct Blobs { /* private fields */ }

Blobs API

Implementations

impl Blobs

pub async fn batch(&self) -> Result<Batch<'_>>

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] and therefore can be used to read the blob’s content.

Any access to parts of the blob that are not present will result in an error.

Example:

use iroh_blobs::{store::mem::MemStore, api::blobs::Blobs};
use tokio::io::AsyncReadExt;

let store = MemStore::new();
let tag = store.add_slice(b"Hello, world!").await?;
let mut reader = store.reader(tag.hash);
let mut buf = String::new();
reader.read_to_string(&mut buf).await?;
assert_eq!(buf, "Hello, world!");
}

pub fn reader_with_opts(&self, options: ReaderOptions) -> BlobReader

Create a reader for the given options. The reader implements [tokio::io::AsyncRead] and [tokio::io::AsyncSeek] and therefore can be used to read the blob’s content.

Any access to parts of the blob that are not present will result in an error.

pub fn add_slice(&self, data: impl AsRef<[u8]>) -> AddProgress<'_>

pub fn add_bytes(&self, data: impl Into<Bytes>) -> AddProgress<'_>

pub fn add_bytes_with_opts( &self, options: impl Into<AddBytesOptions>, ) -> AddProgress<'_>

pub fn add_path_with_opts( &self, options: impl Into<AddPathOptions>, ) -> AddProgress<'_>

pub fn add_path(&self, path: impl AsRef<Path>) -> AddProgress<'_>

pub async fn add_stream( &self, data: impl Stream<Item = Result<Bytes>> + Send + Sync + 'static, ) -> AddProgress<'_>

pub fn export_ranges( &self, hash: impl Into<Hash>, ranges: impl Into<RangeSet2<u64>>, ) -> ExportRangesProgress

pub fn export_ranges_with_opts( &self, options: ExportRangesOptions, ) -> ExportRangesProgress

pub fn export_bao_with_opts( &self, options: ExportBaoOptions, local_update_cap: usize, ) -> ExportBaoProgress

pub fn export_bao( &self, hash: impl Into<Hash>, ranges: impl Into<ChunkRanges>, ) -> ExportBaoProgress

pub async fn export_chunk( &self, hash: impl Into<Hash>, offset: u64, ) -> ExportBaoResult<Leaf>

Export a single chunk from the given hash, at the given offset.

pub async fn get_bytes(&self, hash: impl Into<Hash>) -> ExportBaoResult<Bytes>

Get the entire blob into a Bytes

This will run out of memory when called for very large blobs, so be careful!

pub fn observe(&self, hash: impl Into<Hash>) -> ObserveProgress

Observe the bitfield of the given hash.

pub fn observe_with_opts(&self, options: ObserveOptions) -> ObserveProgress

pub fn export_with_opts(&self, options: ExportOptions) -> ExportProgress

pub fn export( &self, hash: impl Into<Hash>, target: impl AsRef<Path>, ) -> ExportProgress

pub fn list(&self) -> BlobsListProgress

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

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

Trait Implementations

impl Clone for Blobs

fn clone(&self) -> Blobs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Blobs

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

Formats the value using the given formatter.

impl RefCast for Blobs

type From = Client<Request>

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self