Frame

Struct Frame 

Source
pub struct Frame {
    pub command: String,
    pub headers: Vec<(String, String)>,
    pub body: Vec<u8>,
}
Expand description

A simple representation of a STOMP frame.

Frame contains the command (e.g. “SEND”, “MESSAGE”), an ordered list of headers (key/value pairs) and the raw body bytes.

Fields§

§command: String

STOMP command (e.g. CONNECT, SEND, SUBSCRIBE)

§headers: Vec<(String, String)>

Ordered headers as (key, value) pairs

§body: Vec<u8>

Raw body bytes

Implementations§

Source§

impl Frame

Source

pub fn new(command: impl Into<String>) -> Self

Create a new frame with the given command and empty headers/body.

Parameters

  • command: the STOMP command name (for example, "SEND" or "SUBSCRIBE"). Accepts any type convertible into String.
Source

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a header (builder style).

Parameters

  • key: header name (converted to String).
  • value: header value (converted to String).

Returns the mutated Frame allowing builder-style chaining.

Source

pub fn set_body(self, body: impl Into<Vec<u8>>) -> Self

Set the frame body (builder style).

Parameters

  • body: raw body bytes. Accepts any type convertible into Vec<u8>.

Returns the mutated Frame allowing builder-style chaining.

Source

pub fn receipt(self, id: impl Into<String>) -> Self

Request a receipt for this frame (builder style).

When sent, the server will respond with a RECEIPT frame containing the same receipt ID. Use this with Connection::wait_for_receipt() to confirm delivery.

Parameters

  • id: the receipt identifier. Must be unique per connection.

Returns the mutated Frame allowing builder-style chaining.

§Example
let frame = Frame::new("SEND")
    .header("destination", "/queue/test")
    .receipt("msg-001")
    .set_body(b"hello".to_vec());
Source

pub fn get_header(&self, key: &str) -> Option<&str>

Get the value of a header by name.

Returns the first header value matching the given key (case-sensitive), or None if no such header exists.

Trait Implementations§

Source§

impl Clone for Frame

Source§

fn clone(&self) -> Frame

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Frame

Source§

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

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

impl Display for Frame

Source§

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

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

impl PartialEq for Frame

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for Frame

Source§

impl StructuralPartialEq for Frame

Auto Trait Implementations§

§

impl Freeze for Frame

§

impl RefUnwindSafe for Frame

§

impl Send for Frame

§

impl Sync for Frame

§

impl Unpin for Frame

§

impl UnwindSafe for Frame

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.