Skip to main content

TestnetBuilder

Struct TestnetBuilder 

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

Builder for creating a Testnet with custom configuration.

§Defaults

  • bind_address: 127.0.0.1 (localhost)
  • seeded: true - nodes start with fully populated routing tables

§Example

use std::net::Ipv4Addr;
use mainline::Testnet;

// Use localhost (default)
let testnet = Testnet::builder(3).build().unwrap();

// Use all interfaces (0.0.0.0)
let testnet = Testnet::builder(3)
    .bind_address(Ipv4Addr::UNSPECIFIED)
    .build()
    .unwrap();

Implementations§

Source§

impl TestnetBuilder

Source

pub fn new(count: usize) -> Self

Create a new builder with the specified number of nodes.

§Defaults
  • bind_address: 127.0.0.1 (localhost)
  • seeded: true
Source

pub fn bind_address(&mut self, bind_address: Ipv4Addr) -> &mut Self

Set the address to bind all nodes to.

Defaults to 127.0.0.1 (localhost). Use Ipv4Addr::UNSPECIFIED (0.0.0.0) to bind to all interfaces.

Source

pub fn seeded(&mut self, seeded: bool) -> &mut Self

Whether to pre-seed routing tables with all nodes.

Defaults to true.

When true, all nodes start with fully populated routing tables. When false, nodes bootstrap from each other which is faster at startup but may not have immediate full connectivity.

Source

pub fn build(&self) -> Result<Testnet, Error>

Build the testnet.

Nodes will be bound to the configured bind_address (default: 127.0.0.1).

This will block until all nodes are created (and seeded if seeded is true).

Trait Implementations§

Source§

impl Clone for TestnetBuilder

Source§

fn clone(&self) -> TestnetBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TestnetBuilder

Source§

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

Formats the value using the given formatter. 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> 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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