Struct BlobsProtocol

pub struct BlobsProtocol { /* private fields */ }

A protocol handler for the blobs protocol.

Implementations

impl BlobsProtocol

pub fn new( store: &Store, endpoint: Endpoint, events: Option<Sender<Event>>, ) -> Self

pub fn store(&self) -> &Store

pub fn endpoint(&self) -> &Endpoint

pub async fn ticket( &self, content: impl Into<HashAndFormat>, ) -> Result<BlobTicket>

Create a ticket for content on this node.

Note that this does not check whether the content is partially or fully available. It is just a convenience method to create a ticket from content and the address of this node.

Methods from Deref<Target = Store>

pub fn tags(&self) -> &Tags

The tags API.

pub fn blobs(&self) -> &Blobs

The blobs API.

pub fn remote(&self) -> &Remote

API for getting blobs from a single remote node.

pub fn downloader(&self, endpoint: &Endpoint) -> Downloader

Create a downloader for more complex downloads.

Unlike the other APIs, this creates an object that has internal state, so don’t create it ad hoc but store it somewhere if you need it multiple times.

pub async fn sync_db(&self) -> RequestResult<()>

pub async fn shutdown(&self) -> Result<()>

Methods from Deref<Target = Blobs>

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

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 BlobsProtocol

fn clone(&self) -> BlobsProtocol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlobsProtocol

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

Formats the value using the given formatter.

impl Deref for BlobsProtocol

type Target = Store

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ProtocolHandler for BlobsProtocol

fn accept( &self, conn: Connection, ) -> impl Future<Output = Result<(), AcceptError>> + Send

Handle an incoming connection.

fn shutdown(&self) -> impl Future<Output = ()> + Send

Called when the router shuts down.

fn on_connecting( &self, connecting: Connecting, ) -> impl Future<Output = Result<Connection, AcceptError>> + Send

Optional interception point to handle the Connecting state.