Struct Header 

pub struct Header {
    pub header: u8,
    pub version: [u8; 2],
    pub pkt_type: PktType,
    pub topic_length: u8,
    pub message_length: u16,
    pub padding: u8,
}

Header for the pub/sub packet total length 8 bytes.

Fields

header: u8

start byte of the packet, default value: 0x0F

version: [u8; 2]

pub-sub version: two bytes.

pkt_type: PktType

packet type: PktType

topic_length: u8

topic length for publishing/subscribing/querying.

message_length: u16

message length: Max length 16 MB.

padding: u8

padding/endo of the header: 0x00

Implementations

impl Header

pub fn new(pkt_type: PktType, topic_len: u8, message_len: u16) -> Header

creates a new Header with the given data.

use simple_pub_sub_message::header::Header;
use simple_pub_sub_message::PktType;
Header::new(PktType::PUBLISH, 8, 20);

pub fn response_header(&self) -> Result<Header, Error>

returns a Header for the response Msg.

use simple_pub_sub_message::header::Header;
use simple_pub_sub_message::PktType;
let header = Header::new(PktType::PUBLISH, 8, 20);
let response_header = header.response_header();

pub fn bytes(&self) -> [u8; 8]

returns the bytes for Header.

use simple_pub_sub_message::header::Header;
use simple_pub_sub_message::PktType;
let header = Header::new(PktType::PUBLISH, 8, 20);
header.bytes();

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 TryFrom<&[u8]> for Header

fn try_from(bytes: &[u8]) -> Result<Header, Error>

Parses a Header from a &[u8]

use simple_pub_sub_message::header::Header;
Header::try_from([
       15,    // HEADER_BYTE`
       0, 1,  // `VERSION_BYTE_0`, `VERSION_BYTE_1`
       2,     // `PktType`
       3,     // `TOPIC_LENGTH_BYTE`
       0, 12, // `MESSAGE_LENGTH_BYTE_0`, `MESSAGE_LENGTH_BYTE_1`
       0,     // `PADDING_BYTE`
].as_ref());

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Vec<u8>> for Header

fn try_from(bytes: Vec<u8>) -> Result<Header, Error>

Parses a Header from a Vec<u8>.

use simple_pub_sub_message::header::Header;
Header::try_from(vec![
       15,    // `HEADER_BYTE`
       0, 1,  // `VERSION_BYTE_0`, `VERSION_BYTE_1`
       2,     // `PktType`
       3,     // `TOPIC_LENGTH_BYTE`
       0, 12, // `MESSAGE_LENGTH_BYTE_0`, `MESSAGE_LENGTH_BYTE_1`
       0,     // `PADDING_BYTE`
]);

type Error = Error

The type returned in the event of a conversion error.

impl StructuralPartialEq for Header