Struct opendal::services::ipfs::Backend

source · [−]

pub struct Backend { /* private fields */ }

Expand description

Backend for IPFS.

Trait Implementations

source

impl Accessor for Backend

source

fn stat<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 __arg2: OpStat
) -> Pin<Box<dyn Future<Output = Result<ObjectMetadata>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

IPFS’s stat behavior highly depends on its implementation.

Based on IPFS Path Gateway Specification, response payload could be:

UnixFS (implicit default)

File

Bytes representing file contents

Directory

Generated HTML with directory index

When index.html is present, gateway can skip generating directory index and return it instead

Raw block (not this case)

CAR (not this case)

When we HEAD a given path, we could have the following responses:

File

:) curl -I https://ipfs.io/ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ/normal_file
HTTP/1.1 200 Connection established

HTTP/2 200
server: openresty
date: Thu, 08 Sep 2022 00:48:50 GMT
content-type: application/octet-stream
content-length: 262144
access-control-allow-methods: GET
cache-control: public, max-age=29030400, immutable
etag: "QmdP6teFTLSNVhT4W5jkhEuUBsjQ3xkp1GmRvDU6937Me1"
x-ipfs-gateway-host: ipfs-bank11-fr2
x-ipfs-path: /ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ/normal_file
x-ipfs-roots: QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ,QmdP6teFTLSNVhT4W5jkhEuUBsjQ3xkp1GmRvDU6937Me1
x-ipfs-pop: ipfs-bank11-fr2
timing-allow-origin: *
x-ipfs-datasize: 262144
access-control-allow-origin: *
access-control-allow-methods: GET, POST, OPTIONS
access-control-allow-headers: X-Requested-With, Range, Content-Range, X-Chunked-Output, X-Stream-Output
access-control-expose-headers: Content-Range, X-Chunked-Output, X-Stream-Output
x-ipfs-lb-pop: gateway-bank1-fr2
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-proxy-cache: MISS
accept-ranges: bytes

Dir with generated index

:( curl -I https://ipfs.io/ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ/normal_dir
HTTP/1.1 200 Connection established

HTTP/2 200
server: openresty
date: Wed, 07 Sep 2022 08:46:13 GMT
content-type: text/html
vary: Accept-Encoding
access-control-allow-methods: GET
etag: "DirIndex-2b567f6r5vvdg_CID-QmY44DyCDymRN1Qy7sGbupz1ysMkXTWomAQku5vBg7fRQW"
x-ipfs-gateway-host: ipfs-bank6-sg1
x-ipfs-path: /ipfs/QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ/normal_dir
x-ipfs-roots: QmPpCt1aYGb9JWJRmXRUnmJtVgeFFTJGzWFYEEX7bo9zGJ,QmY44DyCDymRN1Qy7sGbupz1ysMkXTWomAQku5vBg7fRQW
x-ipfs-pop: ipfs-bank6-sg1
timing-allow-origin: *
access-control-allow-origin: *
access-control-allow-methods: GET, POST, OPTIONS
access-control-allow-headers: X-Requested-With, Range, Content-Range, X-Chunked-Output, X-Stream-Output
access-control-expose-headers: Content-Range, X-Chunked-Output, X-Stream-Output
x-ipfs-lb-pop: gateway-bank3-sg1
strict-transport-security: max-age=31536000; includeSubDomains; preload
x-proxy-cache: MISS

Dir with index.html

:) curl -I http://127.0.0.1:8080/ipfs/QmVturFGV3z4WsP7cRV8Ci4avCdGWYXk2qBKvtAwFUp5Az
HTTP/1.1 302 Found
Access-Control-Allow-Headers: Content-Type
Access-Control-Allow-Headers: Range
Access-Control-Allow-Headers: User-Agent
Access-Control-Allow-Headers: X-Requested-With
Access-Control-Allow-Methods: GET
Access-Control-Allow-Origin: *
Access-Control-Expose-Headers: Content-Length
Access-Control-Expose-Headers: Content-Range
Access-Control-Expose-Headers: X-Chunked-Output
Access-Control-Expose-Headers: X-Ipfs-Path
Access-Control-Expose-Headers: X-Ipfs-Roots
Access-Control-Expose-Headers: X-Stream-Output
Content-Type: text/html; charset=utf-8
Location: /ipfs/QmVturFGV3z4WsP7cRV8Ci4avCdGWYXk2qBKvtAwFUp5Az/
X-Ipfs-Path: /ipfs/QmVturFGV3z4WsP7cRV8Ci4avCdGWYXk2qBKvtAwFUp5Az
X-Ipfs-Roots: QmVturFGV3z4WsP7cRV8Ci4avCdGWYXk2qBKvtAwFUp5Az
Date: Thu, 08 Sep 2022 00:52:29 GMT

In conclusion:

HTTP Status Code == 302 => directory
HTTP Status Code == 200 && ETag starts with "DirIndex => directory
HTTP Status Code == 200 && ETag not starts with "DirIndex => file

source

fn metadata(&self) -> AccessorMetadata

Invoke the metadata operation to get metadata of accessor.

source

fn read<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpRead
) -> Pin<Box<dyn Future<Output = Result<BytesReader>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the read operation on the specified path, returns a BytesReader if operate successful. Read more

source

fn list<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 __arg2: OpList
) -> Pin<Box<dyn Future<Output = Result<DirStreamer>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the list operation on the specified path. Read more

source

fn create<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpCreate
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the create operation on the specified path Read more

source

fn write<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpWrite,
 r: BytesReader
) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the write operation on the specified path, returns a written size if operate successful. Read more

source

fn delete<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpDelete
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the delete operation on the specified path. Read more

source

fn presign(&self, path: &str, args: OpPresign) -> Result<PresignedRequest>

Invoke the presign operation on the specified path. Read more

source

fn create_multipart<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpCreateMultipart
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the create_multipart operation on the specified path. Read more

source

fn write_multipart<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpWriteMultipart,
 r: BytesReader
) -> Pin<Box<dyn Future<Output = Result<ObjectPart>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the write_multipart operation on the specified path. Read more

source

fn complete_multipart<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpCompleteMultipart
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the complete_multipart operation on the specified path. Read more

source

fn abort_multipart<'life0, 'life1, 'async_trait>(
 &'life0 self,
 path: &'life1 str,
 args: OpAbortMultipart
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
 'life0: 'async_trait,
 'life1: 'async_trait,
 Self: 'async_trait,

Invoke the abort_multipart operation on the specified path. Read more

source

fn blocking_create(&self, path: &str, args: OpCreate) -> Result<()>

Invoke the blocking_create operation on the specified path. Read more

source

fn blocking_read(&self, path: &str, args: OpRead) -> Result<BlockingBytesReader>

Invoke the blocking_read operation on the specified path. Read more

source

fn blocking_write(
 &self,
 path: &str,
 args: OpWrite,
 r: BlockingBytesReader
) -> Result<u64>

Invoke the blocking_write operation on the specified path. Read more

source

fn blocking_stat(&self, path: &str, args: OpStat) -> Result<ObjectMetadata>

Invoke the blocking_stat operation on the specified path. Read more

source

fn blocking_delete(&self, path: &str, args: OpDelete) -> Result<()>

Invoke the blocking_delete operation on the specified path. Read more

source

fn blocking_list(&self, path: &str, args: OpList) -> Result<DirIterator>

Invoke the blocking_list operation on the specified path. Read more

source

impl Clone for Backend

source

fn clone(&self) -> Backend

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Backend

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Backend

impl Send for Backend

impl Sync for Backend

impl Unpin for Backend

impl !UnwindSafe for Backend

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> CompatExt for T

source

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more

source

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more

source

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct opendal::services::ipfs::Backend

Trait Implementations

impl Accessor for Backend

fn stat<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, __arg2: OpStat) -> Pin<Box<dyn Future<Output = Result<ObjectMetadata>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn metadata(&self) -> AccessorMetadata

fn read<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpRead) -> Pin<Box<dyn Future<Output = Result<BytesReader>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn list<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, __arg2: OpList) -> Pin<Box<dyn Future<Output = Result<DirStreamer>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn create<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpCreate) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn write<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpWrite, r: BytesReader) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpDelete) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn presign(&self, path: &str, args: OpPresign) -> Result<PresignedRequest>

fn create_multipart<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpCreateMultipart) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn write_multipart<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpWriteMultipart, r: BytesReader) -> Pin<Box<dyn Future<Output = Result<ObjectPart>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn complete_multipart<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpCompleteMultipart) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn abort_multipart<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 str, args: OpAbortMultipart) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

fn blocking_create(&self, path: &str, args: OpCreate) -> Result<()>

fn blocking_read(&self, path: &str, args: OpRead) -> Result<BlockingBytesReader>

fn blocking_write( &self, path: &str, args: OpWrite, r: BlockingBytesReader) -> Result<u64>

fn blocking_stat(&self, path: &str, args: OpStat) -> Result<ObjectMetadata>

fn blocking_delete(&self, path: &str, args: OpDelete) -> Result<()>

fn blocking_list(&self, path: &str, args: OpList) -> Result<DirIterator>

impl Clone for Backend

fn clone(&self) -> Backend

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

impl Debug for Backend

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

Auto Trait Implementations

impl !RefUnwindSafe for Backend

impl Send for Backend

impl Sync for Backend

impl Unpin for Backend

impl !UnwindSafe for Backend

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CompatExt for T

fn compat(self) -> Compat<T>

fn compat_ref(&self) -> Compat<&T>

fn compat_mut(&mut self) -> Compat<&mut T>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

fn stat<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
__arg2: OpStat
) -> Pin<Box<dyn Future<Output = Result<ObjectMetadata>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn read<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpRead
) -> Pin<Box<dyn Future<Output = Result<BytesReader>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn list<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
__arg2: OpList
) -> Pin<Box<dyn Future<Output = Result<DirStreamer>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn create<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpCreate
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn write<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpWrite,
r: BytesReader
) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn delete<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpDelete
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn create_multipart<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpCreateMultipart
) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn write_multipart<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpWriteMultipart,
r: BytesReader
) -> Pin<Box<dyn Future<Output = Result<ObjectPart>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn complete_multipart<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpCompleteMultipart
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn abort_multipart<'life0, 'life1, 'async_trait>(
&'life0 self,
path: &'life1 str,
args: OpAbortMultipart
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,

fn blocking_write(
&self,
path: &str,
args: OpWrite,
r: BlockingBytesReader
) -> Result<u64>

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,