Struct Frame

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

One STOMP frame (command + headers + body).

Headers are a list, not a map: duplicates are kept, and Self::header returns the first match. The body is not UTF-8 checked.

Fields

command: String

headers: Vec<(String, String)>

body: Vec<u8>

Implementations

impl Frame

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

An empty frame with this command and no headers or body.

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Appends a header. Does not replace an existing name.

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

Replaces the body. Does not set content-length; Self::encode adds that if the headers do not already name it.

pub fn header(&self, name: &str) -> Option<&str>

First header value whose name equals name. Case-sensitive.

pub fn encode(&self) -> Vec<u8>

Encodes command, headers, optional content-length, body, and a trailing NUL.

Header names and values are escaped (\\, \\c, \\n, \\r). content-length is added only when the headers do not already include it, so a caller can lie about the length if it wants to.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Display for Frame

The command only. Use Frame::encode for the wire form.

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

Formats the value using the given formatter.

impl PartialEq for Frame

fn eq(&self, other: &Frame) -> 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 Frame

impl StructuralPartialEq for Frame