Struct Blobs

pub struct Blobs<S> { /* private fields */ }

Available on crate feature net_protocol only.

Blobs protocol handler.

Implementations

impl<S> Blobs<S>

pub fn builder(store: S) -> Builder<S>

Create a new Blobs protocol handler builder, given a store.

impl Blobs<Store>

pub fn memory() -> Builder<Store>

Create a new memory-backed Blobs protocol handler.

impl Blobs<Store>

pub async fn persistent(path: impl AsRef<Path>) -> Result<Builder<Store>>

Load a persistent Blobs protocol handler from a path.

impl<S: Store> Blobs<S>

pub fn new( store: S, rt: LocalPoolHandle, events: EventSender, downloader: Downloader, endpoint: Endpoint, ) -> Self

Create a new Blobs protocol handler.

This is the low-level constructor that allows you to customize everything. If you don’t need that, consider using Blobs::builder.

pub fn store(&self) -> &S

Get the store.

pub fn events(&self) -> &EventSender

Get the event sender.

pub fn rt(&self) -> &LocalPoolHandle

Get the local pool handle.

pub fn downloader(&self) -> &Downloader

Get the downloader.

pub fn endpoint(&self) -> &Endpoint

Get the endpoint.

pub fn add_protected(&self, cb: ProtectCb) -> Result<()>

Add a callback that will be called before the garbage collector runs.

This can only be called before the garbage collector has started, otherwise it will return an error.

pub fn start_gc(&self, config: GcConfig) -> Result<()>

Start garbage collection with the given settings.

impl<D: Store> Blobs<D>

pub fn client(&self) -> &MemClient

Available on crate feature rpc only.

Get a client for the blobs protocol

pub async fn handle_rpc_request<C>( self, msg: Request, chan: RpcChannel<RpcService, C>, ) -> Result<(), RpcServerError<C>>

where C: ChannelTypes<RpcService>,

Available on crate feature rpc only.

Handle an RPC request

Trait Implementations

impl<S: Clone> Clone for Blobs<S>

fn clone(&self) -> Blobs<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for Blobs<S>

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

Formats the value using the given formatter.

impl<S: Store> ProtocolHandler for Blobs<S>

fn accept(&self, conn: Connecting) -> BoxedFuture<Result<()>>

Handle an incoming connection.

fn shutdown(&self) -> BoxedFuture<()>

Called when the node shuts down.