Skip to main content

NetworkConfig

Struct NetworkConfig 

Source
pub struct NetworkConfig {
Show 16 fields pub listen_addrs: Vec<String>, pub bootstrap_peers: Vec<String>, pub enable_quic: bool, pub data_dir: PathBuf, pub enable_mdns: bool, pub enable_nat_traversal: bool, pub relay_servers: Vec<String>, pub kademlia: KademliaConfig, pub max_connections: Option<usize>, pub max_inbound_connections: Option<usize>, pub max_outbound_connections: Option<usize>, pub connection_buffer_size: usize, pub low_memory_mode: bool, pub dcutr_enabled: bool, pub relay_v2_enabled: bool, pub hole_punch_timeout: Duration,
}
Expand description

Network configuration

Fields§

§listen_addrs: Vec<String>

Listen addresses

§bootstrap_peers: Vec<String>

Bootstrap peers

§enable_quic: bool

Enable QUIC transport

§data_dir: PathBuf

Data directory

§enable_mdns: bool

Enable mDNS peer discovery

§enable_nat_traversal: bool

Enable NAT traversal (AutoNAT + DCUtR)

§relay_servers: Vec<String>

Relay server addresses for NAT traversal

§kademlia: KademliaConfig

Kademlia DHT configuration

§max_connections: Option<usize>

Maximum number of concurrent connections (None = unlimited)

§max_inbound_connections: Option<usize>

Maximum number of inbound connections (None = unlimited)

§max_outbound_connections: Option<usize>

Maximum number of outbound connections (None = unlimited)

§connection_buffer_size: usize

Connection buffer size in bytes

§low_memory_mode: bool

Enable aggressive memory optimizations

§dcutr_enabled: bool

Enable DCUtR hole-punching (default: true)

When true the dcutr behaviour actively participates in NAT hole-punch coordination with peers. Disabling this is useful for low-memory constrained environments where the small overhead of maintaining the DCUtR state machine is undesirable.

§relay_v2_enabled: bool

Enable Circuit Relay v2 client behaviour (default: true)

The relay client transport is always compiled in (because removing it from the combined transport would break the swarm type), but this flag controls whether the node actively seeks relay reservations.

§hole_punch_timeout: Duration

Timeout for a single hole-punch attempt (default: 30 s)

Implementations§

Source§

impl NetworkConfig

Source

pub fn low_memory() -> Self

Create a low-memory configuration for constrained devices

This configuration minimizes memory usage at the cost of some features:

  • Limited to 16 total connections
  • Smaller connection buffers (8 KB)
  • Reduced DHT parameters
  • mDNS disabled
  • NAT traversal disabled

Suitable for embedded devices with < 128 MB RAM

Source

pub fn iot() -> Self

Create an IoT device configuration

Balanced configuration for IoT devices:

  • Limited to 32 total connections
  • Moderate connection buffers (16 KB)
  • Reduced DHT parameters
  • mDNS enabled for local discovery
  • NAT traversal enabled

Suitable for IoT devices with 128-512 MB RAM

Source

pub fn mobile() -> Self

Create a mobile device configuration

Power and bandwidth-aware configuration for mobile devices:

  • Limited to 64 total connections
  • Standard connection buffers (32 KB)
  • Standard DHT parameters
  • mDNS disabled (battery saving)
  • NAT traversal enabled

Suitable for mobile devices with network switching

Source

pub fn high_performance() -> Self

Create a high-performance configuration for servers

Optimized for high throughput and many connections:

  • Unlimited connections
  • Large connection buffers (128 KB)
  • Aggressive DHT parameters
  • All features enabled

Suitable for servers with > 2 GB RAM

Trait Implementations§

Source§

impl Clone for NetworkConfig

Source§

fn clone(&self) -> NetworkConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NetworkConfig

Source§

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

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

impl Default for NetworkConfig

Source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

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

Source§

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

Source§

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

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