Struct kitsune_p2p::KitsuneP2pConfig

#[non_exhaustive]
pub struct KitsuneP2pConfig {
    pub transport_pool: Vec<TransportConfig>,
    pub bootstrap_service: Option<Url2>,
    pub tuning_params: KitsuneP2pTuningParams,
    pub network_type: NetworkType,
    pub tracing_scope: Option<String>,
}

Configure the kitsune actor.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

transport_pool: Vec<TransportConfig>

List of sub-transports to be included in this pool

bootstrap_service: Option<Url2>

The service used for peers to discover each before they are peers.

tuning_params: KitsuneP2pTuningParams

Network tuning parameters. These are managed loosely, as they are subject to change. If you specify a tuning parameter that no longer exists, or a value that does not parse, a warning will be printed in the tracing log.

network_type: NetworkType

The network used for connecting to other peers

tracing_scope: Option<String>

All tracing logs from kitsune tasks will be instrumented to contain this string, so that logs from multiple instances in the same process can be disambiguated.

Implementations

impl KitsuneP2pConfig

pub fn is_tx2(&self) -> bool

This config is making use of tx2 transport

pub fn is_tx5(&self) -> bool

This config is making use of tx5 transport

pub fn tune( self, f: impl Fn(KitsuneP2pTuningParams) -> KitsuneP2pTuningParams ) -> Self

Return a copy with the tuning params altered

Trait Implementations

impl Clone for KitsuneP2pConfig

fn clone(&self) -> KitsuneP2pConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KitsuneP2pConfig

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

Formats the value using the given formatter.

impl Default for KitsuneP2pConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KitsuneP2pConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KitsuneP2pConfig

fn eq(&self, other: &KitsuneP2pConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for KitsuneP2pConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KitsuneP2pConfig