Struct madsim::runtime::NodeBuilder
source · pub struct NodeBuilder<'a> { /* private fields */ }
Available on
madsim
only.Expand description
Builds a node with custom configurations.
Implementations§
source§impl<'a> NodeBuilder<'a>
impl<'a> NodeBuilder<'a>
sourcepub fn name(self, name: impl Into<String>) -> Self
pub fn name(self, name: impl Into<String>) -> Self
Names the node.
The default name is node ID.
sourcepub fn init<F>(self, new_task: impl Fn() -> F + Send + Sync + 'static) -> Selfwhere
F: Future + 'static,
pub fn init<F>(self, new_task: impl Fn() -> F + Send + Sync + 'static) -> Selfwhere
F: Future + 'static,
Set the initial task for the node.
This task will be respawned when calling restart
.
sourcepub fn restart_on_panic(self) -> Self
pub fn restart_on_panic(self) -> Self
Automatically restart the node when it panics.
By default a panic will terminate the simulation.
sourcepub fn restart_on_panic_matching(self, msg: impl Into<String>) -> Self
pub fn restart_on_panic_matching(self, msg: impl Into<String>) -> Self
Automatically restart the node when it panics with a message containing the given string.
sourcepub fn cores(self, cores: usize) -> Self
pub fn cores(self, cores: usize) -> Self
Set the number of CPU cores of the node.
This will be the return value of std::thread::available_parallelism
.
sourcepub fn build(self) -> NodeHandle
pub fn build(self) -> NodeHandle
Build a node.
Auto Trait Implementations§
impl<'a> Freeze for NodeBuilder<'a>
impl<'a> !RefUnwindSafe for NodeBuilder<'a>
impl<'a> Send for NodeBuilder<'a>
impl<'a> Sync for NodeBuilder<'a>
impl<'a> Unpin for NodeBuilder<'a>
impl<'a> !UnwindSafe for NodeBuilder<'a>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.