Struct Node

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

Node abstraction for Zenobuf

A Node is the main entry point for using Zenobuf. It provides methods for creating publishers, subscribers, services, and clients.

Implementations§

Source§

impl Node

Source

pub async fn new(name: &str) -> Result<Self>

Creates a new Node with the given name

Source

pub fn with_transport(name: &str, transport: ZenohTransport) -> Result<Self>

Creates a new Node with the given name and transport

Source

pub fn name(&self) -> &str

Returns the name of the node

Source

pub async fn create_publisher<M: Message>( &self, topic: &str, _qos: QosProfile, ) -> Result<Arc<Publisher<M>>>

Creates a publisher for the given topic

Source

pub async fn create_subscriber<M: Message, F>( &self, topic: &str, _qos: QosProfile, callback: F, ) -> Result<Arc<Subscriber>>
where F: Fn(M) + Send + Sync + 'static,

Creates a subscriber for the given topic with a callback

Source

pub async fn create_service<Req: Message, Res: Message, F>( &self, service_name: &str, handler: F, ) -> Result<Arc<Service>>
where F: Fn(Req) -> Result<Res> + Send + Sync + 'static,

Creates a service for the given name with a handler

Source

pub fn create_client<Req: Message, Res: Message>( &self, service_name: &str, ) -> Result<Arc<Client<Req, Res>>>

Creates a client for the given service name

Source

pub fn set_parameter<T: Serialize + DeserializeOwned + Clone + Send + Sync + 'static>( &self, name: &str, value: T, ) -> Result<()>

Sets a parameter

Source

pub fn get_parameter<T: DeserializeOwned + Clone + Send + Sync + 'static>( &self, name: &str, ) -> Result<T>

Gets a parameter

Source

pub fn spin_once(&self) -> Result<()>

Spins the node once, processing all pending callbacks

Source

pub async fn spin(&self) -> Result<()>

Spins the node, processing callbacks until the node is shutdown

Source

pub fn publisher<M: Message>(&self, topic: &str) -> PublisherBuilder<'_, M>

Creates a publisher builder for the given topic

Source

pub fn subscriber<M: Message>(&self, topic: &str) -> SubscriberBuilder<'_, M>

Creates a subscriber builder for the given topic

Source

pub fn service<Req: Message, Res: Message>( &self, name: &str, ) -> ServiceBuilder<'_, Req, Res>

Creates a service builder for the given service name

Source

pub fn client<Req: Message, Res: Message>( &self, name: &str, ) -> ClientBuilder<'_, Req, Res>

Creates a client builder for the given service name

Source

pub async fn publish<M: Message>( &self, topic: &str, ) -> Result<Arc<Publisher<M>>>

Creates a publisher with default QoS

Source

pub async fn subscribe<M: Message, F>( &self, topic: &str, callback: F, ) -> Result<Arc<Subscriber>>
where F: Fn(M) + Send + Sync + 'static,

Creates a subscriber with default QoS and a callback

Auto Trait Implementations§

§

impl !Freeze for Node

§

impl !RefUnwindSafe for Node

§

impl Send for Node

§

impl Sync for Node

§

impl Unpin for Node

§

impl !UnwindSafe for Node

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

Source§

fn as_node(&self) -> &T

Source§

impl<T> AsNodeMut<T> for T

Source§

fn as_node_mut(&mut self) -> &mut T

Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,