Struct rust_ipfs::p2p::SwarmOptions

pub struct SwarmOptions {Show 16 fields
    pub keypair: Keypair,
    pub peer_id: PeerId,
    pub bootstrap: Vec<Multiaddr>,
    pub mdns: bool,
    pub mdns_ipv6: bool,
    pub relay_server: bool,
    pub relay_server_config: Option<RelayConfig>,
    pub kad_config: Option<Either<KadConfig, KademliaConfig>>,
    pub ping_config: Option<PingConfig>,
    pub identify_config: Option<IdentifyConfiguration>,
    pub kad_store_config: Option<KadStoreConfig>,
    pub pubsub_config: Option<PubsubConfig>,
    pub portmapping: bool,
    pub keep_alive: bool,
    pub relay: bool,
    pub dcutr: bool,
}

Expand description

Defines the configuration for an IPFS swarm.

Fields§

§keypair: Keypair

The keypair for the PKI based identity of the local node.

§peer_id: PeerId

The peer address of the local node created from the keypair.

§bootstrap: Vec<Multiaddr>

The peers to connect to on startup.

§mdns: bool

Enables mdns for peer discovery and announcement when true.

§mdns_ipv6: bool

enables ipv6 for mdns

§relay_server: bool

Relay Server

§relay_server_config: Option<RelayConfig>

Relay Server Configuration

§kad_config: Option<Either<KadConfig, KademliaConfig>>

Kademlia Configuration

§ping_config: Option<PingConfig>

Ping Configuration

§identify_config: Option<IdentifyConfiguration>

identify configuration

§kad_store_config: Option<KadStoreConfig>

Kad store config Note: Only supports MemoryStoreConfig at this time

§pubsub_config: Option<PubsubConfig>

Pubsub configuration,

§portmapping: bool

UPnP/PortMapping

§keep_alive: bool

Keep alive

§relay: bool

Relay client

§dcutr: bool

Enables dcutr

Trait Implementations§

impl From<&IpfsOptions> for SwarmOptions

fn from(options: &IpfsOptions) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl RefUnwindSafe for SwarmOptions

impl Send for SwarmOptions

impl Sync for SwarmOptions

impl Unpin for SwarmOptions

impl UnwindSafe for SwarmOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> References<RawCodec> for T

fn references<R, E>(_c: RawCodec, _r: &mut R, _set: &mut E) -> Result<(), Error>where R: Read, E: Extend<Cid<64>>,

Scrape the references from an impl Read. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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