use crate::MqttString;
use super::{
len_len, length, property, read_mqtt_string, read_u16, read_u8, write_mqtt_string,
write_remaining_length, Debug, Error, FixedHeader, PropertyType,
};
use bytes::{Buf, BufMut, Bytes, BytesMut};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum PubRecReason {
Success,
NoMatchingSubscribers,
UnspecifiedError,
ImplementationSpecificError,
NotAuthorized,
TopicNameInvalid,
PacketIdentifierInUse,
QuotaExceeded,
PayloadFormatInvalid,
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PubRec {
pub pkid: u16,
pub reason: PubRecReason,
pub properties: Option<PubRecProperties>,
}
impl PubRec {
#[must_use]
pub fn new(pkid: u16, properties: Option<PubRecProperties>) -> Self {
Self {
pkid,
reason: PubRecReason::Success,
properties,
}
}
#[must_use]
pub fn size(&self) -> usize {
let len = self.len();
let remaining_len_size = len_len(len);
1 + remaining_len_size + len
}
fn len(&self) -> usize {
let mut len = 2 + 1; if self.reason == PubRecReason::Success && self.properties.is_none() {
return 2;
}
if let Some(p) = &self.properties {
let properties_len = p.len();
let properties_len_len = len_len(properties_len);
len += properties_len_len + properties_len;
} else {
len += 1;
}
len
}
pub fn read(fixed_header: FixedHeader, mut bytes: Bytes) -> Result<PubRec, Error> {
let variable_header_index = fixed_header.fixed_header_len;
bytes.advance(variable_header_index);
let pkid = read_u16(&mut bytes)?;
if fixed_header.remaining_len == 2 {
return Ok(PubRec {
pkid,
reason: PubRecReason::Success,
properties: None,
});
}
let ack_reason = read_u8(&mut bytes)?;
if fixed_header.remaining_len < 4 {
return Ok(PubRec {
pkid,
reason: reason(ack_reason)?,
properties: None,
});
}
let properties = PubRecProperties::read(&mut bytes)?;
let puback = PubRec {
pkid,
reason: reason(ack_reason)?,
properties,
};
Ok(puback)
}
pub fn write(&self, buffer: &mut BytesMut) -> Result<usize, Error> {
let len = self.len();
buffer.put_u8(0x50);
let count = write_remaining_length(buffer, len)?;
buffer.put_u16(self.pkid);
if self.reason == PubRecReason::Success && self.properties.is_none() {
return Ok(4);
}
buffer.put_u8(code(self.reason));
if let Some(p) = &self.properties {
p.write(buffer)?;
} else {
write_remaining_length(buffer, 0)?;
}
Ok(1 + count + len)
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct PubRecProperties {
pub reason_string: Option<MqttString>,
pub user_properties: Vec<(MqttString, MqttString)>,
}
impl PubRecProperties {
fn len(&self) -> usize {
let mut len = 0;
if let Some(reason) = &self.reason_string {
len += 1 + 2 + reason.len();
}
for (key, value) in &self.user_properties {
len += 1 + 2 + key.len() + 2 + value.len();
}
len
}
pub fn read(bytes: &mut Bytes) -> Result<Option<PubRecProperties>, Error> {
let mut reason_string = None;
let mut user_properties = Vec::new();
let (properties_len_len, properties_len) = length(bytes.iter())?;
bytes.advance(properties_len_len);
if properties_len == 0 {
return Ok(None);
}
let mut cursor = 0;
while cursor < properties_len {
let prop = read_u8(bytes)?;
cursor += 1;
match property(prop)? {
PropertyType::ReasonString => {
let reason = read_mqtt_string(bytes)?;
cursor += 2 + reason.len();
reason_string = Some(reason);
}
PropertyType::UserProperty => {
let key = read_mqtt_string(bytes)?;
let value = read_mqtt_string(bytes)?;
cursor += 2 + key.len() + 2 + value.len();
user_properties.push((key, value));
}
_ => return Err(Error::InvalidPropertyType(prop)),
}
}
Ok(Some(PubRecProperties {
reason_string,
user_properties,
}))
}
pub fn write(&self, buffer: &mut BytesMut) -> Result<(), Error> {
let len = self.len();
write_remaining_length(buffer, len)?;
if let Some(reason) = &self.reason_string {
buffer.put_u8(PropertyType::ReasonString as u8);
write_mqtt_string(buffer, reason)?;
}
for (key, value) in &self.user_properties {
buffer.put_u8(PropertyType::UserProperty as u8);
write_mqtt_string(buffer, key)?;
write_mqtt_string(buffer, value)?;
}
Ok(())
}
}
fn reason(num: u8) -> Result<PubRecReason, Error> {
let code = match num {
0 => PubRecReason::Success,
16 => PubRecReason::NoMatchingSubscribers,
128 => PubRecReason::UnspecifiedError,
131 => PubRecReason::ImplementationSpecificError,
135 => PubRecReason::NotAuthorized,
144 => PubRecReason::TopicNameInvalid,
145 => PubRecReason::PacketIdentifierInUse,
151 => PubRecReason::QuotaExceeded,
153 => PubRecReason::PayloadFormatInvalid,
num => return Err(Error::InvalidConnectReturnCode(num)),
};
Ok(code)
}
fn code(reason: PubRecReason) -> u8 {
match reason {
PubRecReason::Success => 0,
PubRecReason::NoMatchingSubscribers => 16,
PubRecReason::UnspecifiedError => 128,
PubRecReason::ImplementationSpecificError => 131,
PubRecReason::NotAuthorized => 135,
PubRecReason::TopicNameInvalid => 144,
PubRecReason::PacketIdentifierInUse => 145,
PubRecReason::QuotaExceeded => 151,
PubRecReason::PayloadFormatInvalid => 153,
}
}
#[cfg(test)]
mod test {
use crate::test::read_write_packets;
use crate::Packet;
use super::super::test::{USER_PROP_KEY, USER_PROP_VAL};
use super::*;
use bytes::BytesMut;
use pretty_assertions::assert_eq;
#[test]
fn length_calculation() {
let mut dummy_bytes = BytesMut::new();
let pubrec_props = PubRecProperties {
reason_string: None,
user_properties: vec![(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
};
let pubrec_pkt = PubRec::new(1, Some(pubrec_props));
let size_from_size = pubrec_pkt.size();
let size_from_write = pubrec_pkt.write(&mut dummy_bytes).unwrap();
let size_from_bytes = dummy_bytes.len();
assert_eq!(size_from_write, size_from_bytes);
assert_eq!(size_from_size, size_from_bytes);
}
#[test]
fn test_write_read() {
read_write_packets(write_read_provider());
}
fn write_read_provider() -> Vec<Packet> {
vec![
Packet::PubRec(PubRec {
pkid: 42,
reason: PubRecReason::Success,
properties: None,
}),
Packet::PubRec(PubRec {
pkid: 42,
reason: PubRecReason::Success,
properties: Some(PubRecProperties {
reason_string: None,
user_properties: vec![(USER_PROP_KEY.into(), USER_PROP_VAL.into())],
}),
}),
]
}
}