NetworkBuilder

Struct NetworkBuilder 

Source
pub struct NetworkBuilder { /* private fields */ }
Expand description

Builder for configuring and creating a test network

Implementations§

Source§

impl NetworkBuilder

Source

pub fn new() -> Self

Source

pub fn gateways(self, n: usize) -> Self

Set the number of gateway peers

Source

pub fn peers(self, n: usize) -> Self

Set the number of regular peers

Source

pub fn binary(self, binary: FreenetBinary) -> Self

Set which freenet binary to use

Source

pub fn require_connectivity(self, ratio: f64) -> Self

Set minimum connectivity ratio required (0.0 to 1.0)

Source

pub fn connectivity_timeout(self, timeout: Duration) -> Self

Set timeout for connectivity check

Source

pub fn min_connections(self, min: usize) -> Self

Override min connections target for all peers.

Source

pub fn max_connections(self, max: usize) -> Self

Override max connections target for all peers.

Source

pub fn start_stagger(self, delay: Duration) -> Self

Add a delay between starting successive non-gateway peers.

Source

pub fn preserve_temp_dirs_on_failure(self, preserve: bool) -> Self

Preserve peer data directories in /tmp when network startup fails

Source

pub fn preserve_temp_dirs_on_success(self, preserve: bool) -> Self

Preserve peer data directories in /tmp even when the network boots successfully.

Source

pub fn peer_location(self, index: usize, location: PeerLocation) -> Self

Set the location for a specific peer (by index) Index 0 is the first gateway, subsequent indices are regular peers

Source

pub fn default_location(self, location: PeerLocation) -> Self

Set the default location for all peers not explicitly configured

Source

pub fn distribute_across_remotes(self, machines: Vec<RemoteMachine>) -> Self

Convenience method to set locations for multiple remote machines Distributes peers across the provided machines in round-robin fashion

Source

pub fn backend(self, backend: Backend) -> Self

Set the backend for running peers (Local or DockerNat)

Source

pub async fn build(self) -> Result<TestNetwork>

Build and start the network (async)

Source

pub fn build_sync(self) -> Result<TestNetwork>

Build the network synchronously (for use in LazyLock)

Trait Implementations§

Source§

impl Default for NetworkBuilder

Source§

fn default() -> Self

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

Auto Trait Implementations§

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

Source§

type Output = T

Should always be Self
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