Skip to main content

NodeBuilder

Struct NodeBuilder 

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

Creates a Node.

use iceoryx2::prelude::*;

let node = NodeBuilder::new()
                .name(&"my_little_node".try_into()?)
                .create::<ipc::Service>()?;

// do things with your cool new node

Implementations§

Source§

impl NodeBuilder

Source

pub fn new() -> Self

Creates a new NodeBuilder

Source

pub fn name(self, value: &NodeName) -> Self

Sets the NodeName of the to be created Node.

Source

pub fn signal_handling_mode(self, value: SignalHandlingMode) -> Self

Defines the SignalHandlingMode for the Node. It affects the Node::wait() call that returns any received Signal via its NodeWaitFailure

Source

pub fn config(self, value: &Config) -> Self

Sets the config of the Node that will be used to create all entities owned by the Node.

Source

pub fn create<Service: Service>( self, ) -> Result<Node<Service>, NodeCreationFailure>

Creates a new Node for a specific service::Service. All entities owned by the Node will have the same service::Service.

Trait Implementations§

Source§

impl Clone for NodeBuilder

Source§

fn clone(&self) -> NodeBuilder

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 NodeBuilder

Source§

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

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

impl Default for NodeBuilder

Source§

fn default() -> NodeBuilder

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> 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, 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.