Struct opendal::services::Ipfs

pub struct Ipfs { /* private fields */ }

Available on crate feature services-ipfs only.

IPFS file system support based on IPFS HTTP Gateway.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• scan
• presign
• blocking

Configuration

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

You can refer to IpfsBuilder’s docs for more information

Example

Via Builder

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

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

    // set the endpoint for OpenDAL
    builder.endpoint("https://ipfs.io");
    // set the root for OpenDAL
    builder.root("/ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ");

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

    Ok(())
}

Implementations

impl IpfsBuilder

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

Set root of ipfs backend.

Root must be a valid ipfs address like the following:

• /ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ/ (IPFS with CID v0)
• /ipfs/bafybeibozpulxtpv5nhfa2ue3dcjx23ndh3gwr5vwllk7ptoyfwnfjjr4q/ (IPFS with CID v1)
• /ipns/opendal.apache.org/ (IPNS)

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

Set endpoint if ipfs backend.

Endpoint must be a valid ipfs gateway which passed the IPFS Gateway Checker

Popular choices including:

• https://ipfs.io
• https://w3s.link
• https://dweb.link
• https://cloudflare-ipfs.com
• http://127.0.0.1:8080 (ipfs daemon in local)

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 IpfsBuilder

const SCHEME: Scheme = Scheme::Ipfs

Associated scheme for this builder. It indicates what underlying service is.

type Accessor = IpfsBackend

The accessor that built by this builder.

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

Construct a builder from given map which contains several parameters needed by underlying service.

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

Consume the accessor builder to build a service.

impl Clone for IpfsBuilder

fn clone(&self) -> IpfsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpfsBuilder

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

Formats the value using the given formatter.

impl Default for IpfsBuilder

fn default() -> IpfsBuilder

Returns the “default value” for a type.