Struct Subscriber

pub struct Subscriber<S: Into<String>, I: Into<String>> { /* private fields */ }

Builder to create a Subscribe message with optional custom headers

This struct provides a builder pattern for configuring subscription parameters and creating a SUBSCRIBE message to send to a STOMP server.

Examples

use futures::prelude::*;
use async_stomp::client::Connector;
use async_stomp::client::Subscriber;


#[tokio::main]
async fn main() -> Result<(), anyhow::Error> {
  let mut connection = Connector::builder()
    .server("stomp.example.com")
    .virtualhost("stomp.example.com")
    .login("guest".to_string())
    .passcode("guest".to_string())
    .headers(vec![("client-id".to_string(), "ClientTest".to_string())])
    .connect()
    .await.expect("Client connection");
   
  let subscribe_msg = Subscriber::builder()
    .destination("queue.test")
    .id("custom-subscriber-id")
    .subscribe();

  connection.send(subscribe_msg).await?;
  Ok(())
}

Implementations

impl<S: Into<String>, I: Into<String>> Subscriber<S, I>

pub fn builder() -> SubscriberBuilder<S, I, ((), (), ())>

Create a builder for building Subscriber. On the builder, call .destination(...), .id(...), .headers(...)(optional) to set the values of the fields. Finally, call .__build() to create the instance of Subscriber.

impl<S: Into<String>, I: Into<String>> Subscriber<S, I>

pub fn subscribe(self) -> Message<ToServer>

Creates a SUBSCRIBE message using the configured parameters

This method returns a STOMP SUBSCRIBE message that can be sent to a server to create a subscription with the configured destination, ID, and headers.