Skip to main content

Crate opendal_service_ipmfs

Crate opendal_service_ipmfs 

Source
Expand description

§Apache OpenDAL™ IPFS Mutable File System Service

opendal-service-ipmfs provides access to the IPFS Mutable File System API for applications built with Apache OpenDAL™.

§Use through opendal

Applications should normally enable this service through the opendal facade with the services-ipmfs feature:

cargo add opendal --features services-ipmfs

The service is available as opendal::services::Ipmfs. Configure the service builder, then pass it to opendal::Operator::new.

§Use with opendal-core

Add the split crates directly:

cargo add opendal-core opendal-service-ipmfs

Pass a configured service builder to Operator::new:

use opendal_core::{Operator, OperatorRegistry, Result};
use opendal_service_ipmfs::{register_ipmfs_service, Ipmfs};

fn build_operator(builder: Ipmfs) -> Result<Operator> {
    Operator::new(builder)
}

fn register_for_uri() {
    register_ipmfs_service(OperatorRegistry::get());
}

register_for_uri is only needed for scheme-driven construction through Operator::from_uri or Operator::via_iter.

Services that send HTTP requests also require an HTTP transport in OperationContext. See the opendal-core composition example.

§Documentation

§License

Licensed under the Apache License, Version 2.0.

Structs§

Ipmfs
IPFS file system support based on IPFS MFS API.
IpmfsConfig
Config for IPFS MFS support.

Constants§

IPMFS_SCHEME
URI scheme used for service registration and scheme-driven construction.

Functions§

register_ipmfs_service
Register this service’s URI scheme or schemes with an operator registry.