Enum zenoh::SessionRef

pub enum SessionRef<'a> {
    Borrow(&'a Session),
    Shared(Arc<Session>),
}

Variants

Borrow(&'a Session)

Shared(Arc<Session>)

Methods from Deref<Target = Session>

pub fn zid(&self) -> ZenohId

Returns the identifier of the current session. zid() is a convenient shortcut. See Session::info() and SessionInfo::zid() for more details.

pub fn hlc(&self) -> Option<&HLC>

pub fn undeclare<'a, T, O>(&'a self, decl: T) -> O

where O: Resolve<ZResult<()>>, T: Undeclarable<&'a Self, O, ZResult<()>>,

pub fn config(&self) -> &Notifier<Config>

Get the current configuration of the zenoh Session.

The returned configuration Notifier can be used to read the current zenoh configuration through the get function or modify the zenoh configuration through the insert, or insert_json5 funtion.

Examples

Read current zenoh configuration

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
let peers = session.config().get("connect/endpoints").unwrap();

Modify current zenoh configuration

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
let _ = session.config().insert_json5("connect/endpoints", r#"["tcp/127.0.0.1/7447"]"#);

pub fn declare_keyexpr<'a, 'b: 'a, TryIntoKeyExpr>( &'a self, key_expr: TryIntoKeyExpr ) -> impl Resolve<ZResult<KeyExpr<'b>>> + 'a

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>,

Informs Zenoh that you intend to use key_expr multiple times and that it should optimize its transmission.

The returned KeyExpr’s internal structure may differ from what you would have obtained through a simple key_expr.try_into(), to save time on detecting the optimizations that have been associated with it.

Examples

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
let key_expr = session.declare_keyexpr("key/expression").res().await.unwrap();

pub fn put<'a, 'b: 'a, TryIntoKeyExpr, IntoValue>( &'a self, key_expr: TryIntoKeyExpr, value: IntoValue ) -> PutBuilder<'a, 'b>

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>, IntoValue: Into<Value>,

Put data.

Arguments

• key_expr - Key expression matching the resources to put
• value - The value to put

Examples

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
session
    .put("key/expression", "value")
    .encoding(KnownEncoding::TextPlain)
    .res()
    .await
    .unwrap();

pub fn delete<'a, 'b: 'a, TryIntoKeyExpr>( &'a self, key_expr: TryIntoKeyExpr ) -> DeleteBuilder<'a, 'b>

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>,

Delete data.

Arguments

• key_expr - Key expression matching the resources to delete

Examples

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
session.delete("key/expression").res().await.unwrap();

pub fn get<'a, 'b: 'a, TryIntoSelector>( &'a self, selector: TryIntoSelector ) -> GetBuilder<'a, 'b, DefaultHandler>

where TryIntoSelector: TryInto<Selector<'b>>, <TryIntoSelector as TryInto<Selector<'b>>>::Error: Into<Error>,

Query data from the matching queryables in the system.

Unless explicitly requested via GetBuilder::accept_replies, replies are guaranteed to have key expressions that match the requested selector.

Arguments

• selector - The selection of resources to query

Examples

use zenoh::prelude::r#async::*;

let session = zenoh::open(config::peer()).res().await.unwrap();
let replies = session.get("key/expression").res().await.unwrap();
while let Ok(reply) = replies.recv_async().await {
    println!(">> Received {:?}", reply.sample);
}

Trait Implementations

impl<'a> Clone for SessionRef<'a>

fn clone(&self) -> SessionRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionRef<'_>

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

Formats the value using the given formatter.

impl<'s, 'a> SessionDeclarations<'s, 'a> for SessionRef<'a>

fn declare_subscriber<'b, TryIntoKeyExpr>( &'s self, key_expr: TryIntoKeyExpr ) -> SubscriberBuilder<'a, 'b, PushMode, DefaultHandler>

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>,

Create a Subscriber for the given key expression.

fn declare_queryable<'b, TryIntoKeyExpr>( &'s self, key_expr: TryIntoKeyExpr ) -> QueryableBuilder<'a, 'b, DefaultHandler>

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>,

Create a Queryable for the given key expression.

fn declare_publisher<'b, TryIntoKeyExpr>( &'s self, key_expr: TryIntoKeyExpr ) -> PublisherBuilder<'a, 'b>

where TryIntoKeyExpr: TryInto<KeyExpr<'b>>, <TryIntoKeyExpr as TryInto<KeyExpr<'b>>>::Error: Into<Error>,

Create a Publisher for the given key expression.

fn liveliness(&'s self) -> Liveliness<'a>

Available on crate feature unstable only.

Obtain a Liveliness struct tied to this Zenoh Session.

fn info(&'s self) -> SessionInfo<'a>

Get informations about the zenoh Session.

impl Deref for SessionRef<'_>

type Target = Session

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.