Skip to main content

Ipfs

Struct Ipfs 

Source
pub struct Ipfs {
    pub read_uri: Option<String>,
    pub write_uri: Option<String>,
    pub pinata_api_key: Option<String>,
    pub pinata_api_secret: Option<String>,
}
Expand description

IPFS connection parameters for upload/fetch operations.

Configure read/write gateway URIs and optional Pinata API credentials. Pass an instance to MetadataApi::with_ipfs or directly to upload_app_data_to_pinata.

§Example

use cow_app_data::Ipfs;

let ipfs = Ipfs::default()
    .with_read_uri("https://my-gateway.io/ipfs")
    .with_pinata("my-api-key", "my-api-secret");
assert_eq!(ipfs.read_uri.as_deref(), Some("https://my-gateway.io/ipfs"));

Fields§

§read_uri: Option<String>

IPFS read gateway URI (defaults to DEFAULT_IPFS_READ_URI).

§write_uri: Option<String>

IPFS write gateway URI (defaults to DEFAULT_IPFS_WRITE_URI).

§pinata_api_key: Option<String>

Pinata API key for authenticated uploads.

§pinata_api_secret: Option<String>

Pinata API secret for authenticated uploads.

Implementations§

Source§

impl Ipfs

Source

pub fn with_read_uri(self, uri: impl Into<String>) -> Self

Set the IPFS read gateway URI.

Overrides the default DEFAULT_IPFS_READ_URI (cloudflare-ipfs.com) for all fetch operations.

§Parameters
  • uri — the base URL of the IPFS read gateway (e.g. "https://my-gateway.io/ipfs").
§Returns

self with read_uri set.

Source

pub fn with_write_uri(self, uri: impl Into<String>) -> Self

Set the IPFS write gateway URI.

Overrides the default DEFAULT_IPFS_WRITE_URI (api.pinata.cloud) for all upload operations.

§Parameters
  • uri — the base URL of the IPFS write gateway.
§Returns

self with write_uri set.

Source

pub fn with_pinata( self, api_key: impl Into<String>, api_secret: impl Into<String>, ) -> Self

Set Pinata API credentials for authenticated uploads.

Both the API key and secret are required for upload_app_data_to_pinata to succeed. Obtain them from the Pinata dashboard.

§Parameters
  • api_key — your Pinata API key.
  • api_secret — your Pinata API secret.
§Returns

self with both pinata_api_key and pinata_api_secret set.

Trait Implementations§

Source§

impl Clone for Ipfs

Source§

fn clone(&self) -> Ipfs

Returns a duplicate 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 Ipfs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Ipfs

Source§

fn default() -> Ipfs

Returns the “default value” for a type. Read more
Source§

impl Display for Ipfs

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Ipfs

§

impl RefUnwindSafe for Ipfs

§

impl Send for Ipfs

§

impl Sync for Ipfs

§

impl Unpin for Ipfs

§

impl UnsafeUnpin for Ipfs

§

impl UnwindSafe for Ipfs

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

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<U> for T
where U: From<T>,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
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