Struct TopicCollection 

pub struct TopicCollection { /* private fields */ }

Represents a collection of topics.

This is used to subscribe to multiple topics at once.

Examples

use nt_client::Client;

let client = Client::new(Default::default());

client.connect_setup(setup).await.unwrap();

fn setup(client: &Client) {
    let topics = client.topics(vec![
        "/topic".to_owned(),
        "/nested/topic".to_owned(),
        "/deeply/nested/topic".to_owned(),
    ]);
    tokio::spawn(async move {
        let subscriber = topics.subscribe(Default::default()).await;

        // do something with subscriber...
    });
}

Implementations

impl TopicCollection

pub fn names(&self) -> &Vec<String>

Returns a slice of topic names this collection contains.

pub fn names_mut(&mut self) -> &mut Vec<String>

Returns a mutable slice of topic names this collection contains.

pub async fn subscribe( &self, options: SubscriptionOptions, ) -> Result<Subscriber, ConnectionClosedError>

Subscribes to this collection of topics.

This method does not require the Client websocket connection to be made.

Trait Implementations

impl Clone for TopicCollection

fn clone(&self) -> TopicCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopicCollection

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

Formats the value using the given formatter.

impl IntoIterator for TopicCollection

type Item = Topic

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TopicCollection

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TopicCollection