Struct opendal::services::Ipmfs

pub struct Ipmfs { /* private fields */ }

IPFS file system support based on IPFS MFS API.

Capabilities

This service can be used to:

• read
• write
• list
• scan
• presign
• blocking

Configuration

• root: Set the work directory for backend
• endpoint: Customizable endpoint setting

You can refer to IpmfsBuilder’s docs for more information

Example

Via Builder

use anyhow::Result;
use opendal::services::Ipmfs;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // create backend builder
    let mut builder = Ipmfs::default();

    // set the storage bucket for OpenDAL
    builder.endpoint("http://127.0.0.1:5001");

    let op: Operator = Operator::new(builder)?.finish();

    Ok(())
}

Implementations

impl IpmfsBuilder

pub fn root(&mut self, root: &str) -> &mut Self

Set root for ipfs.

pub fn endpoint(&mut self, endpoint: &str) -> &mut Self

Set endpoint for ipfs.

Default: http://localhost:5001

pub fn http_client(&mut self, client: HttpClient) -> &mut Self

Specify the http client that used by this service.

Notes

This API is part of OpenDAL’s Raw API. HttpClient could be changed during minor updates.

Trait Implementations

impl Builder for IpmfsBuilder

const SCHEME: Scheme = Scheme::Ipmfs

Associated scheme for this builder.

type Accessor = IpmfsBackend

The accessor that built by this builder.

fn from_map(map: HashMap<String, String>) -> Self

Construct a builder from given map.

fn build(&mut self) -> Result<Self::Accessor>

Consume the accessor builder to build a service.

fn from_iter(iter: impl Iterator<Item = (String, String)>) -> Selfwhere
    Self: Sized,

Construct a builder from given iterator.

fn from_env() -> Selfwhere
    Self: Sized,

Construct a builder from envs.

impl Debug for IpmfsBuilder

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

Formats the value using the given formatter.

impl Default for IpmfsBuilder

fn default() -> IpmfsBuilder

Returns the “default value” for a type.