Struct rust_ipfs::IpfsOptions
source · pub struct IpfsOptions {Show 16 fields
pub ipfs_path: StorageType,
pub bootstrap: Vec<Multiaddr>,
pub relay_server_config: RelayConfig,
pub listening_addrs: Vec<Multiaddr>,
pub transport_configuration: TransportConfig,
pub swarm_configuration: SwarmConfig,
pub identify_configuration: IdentifyConfiguration,
pub pubsub_config: PubsubConfig,
pub kad_configuration: Either<KadConfig, Config>,
pub kad_store_config: KadStoreConfig,
pub ping_configuration: Config,
pub addr_config: AddressBookConfig,
pub keystore: Keystore,
pub connection_idle: Duration,
pub provider: RepoProvider,
pub span: Option<Span>,
/* private fields */
}
Expand description
Ipfs node options used to configure the node to be created with UninitializedIpfs
.
Fields§
§ipfs_path: StorageType
The path of the ipfs repo (blockstore and datastore).
This is always required but can be any path with in-memory backends. The filesystem backend creates a directory structure alike but not compatible to other ipfs implementations.
§Incompatiblity and interop warning
It is not recommended to set this to IPFS_PATH without first at least backing up your existing repository.
bootstrap: Vec<Multiaddr>
Nodes used as bootstrap peers.
relay_server_config: RelayConfig
Relay server config
listening_addrs: Vec<Multiaddr>
Bound listening addresses; by default the node will not listen on any address.
transport_configuration: TransportConfig
Transport configuration
swarm_configuration: SwarmConfig
Swarm configuration
identify_configuration: IdentifyConfiguration
Identify configuration
pubsub_config: PubsubConfig
Pubsub configuration
kad_configuration: Either<KadConfig, Config>
Kad configuration
kad_store_config: KadStoreConfig
Kad Store Config Note: Only supports MemoryStoreConfig at this time
ping_configuration: Config
Ping Configuration
addr_config: AddressBookConfig
Address book configuration
keystore: Keystore
§connection_idle: Duration
Connection idle
provider: RepoProvider
Repo Provider option
span: Option<Span>
The span for tracing purposes, None
value is converted to tracing::trace_span!("ipfs")
.
All futures returned by Ipfs
, background task actions and swarm actions are instrumented
with this span or spans referring to this as their parent. Setting this other than None
default is useful when running multiple nodes.
Trait Implementations§
source§impl Debug for IpfsOptions
impl Debug for IpfsOptions
Auto Trait Implementations§
impl Freeze for IpfsOptions
impl !RefUnwindSafe for IpfsOptions
impl Send for IpfsOptions
impl Sync for IpfsOptions
impl Unpin for IpfsOptions
impl !UnwindSafe for IpfsOptions
Blanket Implementations§
source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more