Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement some utility functions #12

Merged
merged 1 commit into from
Oct 22, 2024
Merged

Implement some utility functions #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
123 changes: 123 additions & 0 deletions src/usp_decoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,39 @@ pub fn try_decode_msg(bytes: &[u8]) -> Result<Msg> {

/// Implementation of some extension methods for `Msg`s
impl Msg {
/// Tries to decode a slice of bytes contained a Protobuf encoded USP Message
///
/// This function also performs additional checks required by the USP specification, see also
/// [`Msg::check_validity`]
///
/// # Arguments
///
/// * `bytes` - A slice of bytes containing the Protobuf encoded USP Message
///
/// # Example
///
/// ```
/// use rusp::usp::Msg;
/// let msg =
/// Msg::from_bytes(&[
/// 0x0a, 0x1a, 0x0a, 0x16, 0x41, 0x58, 0x53, 0x53, 0x2d, 0x31, 0x35, 0x34,
/// 0x34, 0x31, 0x31, 0x34, 0x30, 0x34, 0x35, 0x2e, 0x34, 0x34, 0x32, 0x35,
/// 0x39, 0x36, 0x10, 0x02, 0x12, 0x46, 0x12, 0x44, 0x0a, 0x42, 0x0a, 0x40,
/// 0x0a, 0x22, 0x44, 0x65, 0x76, 0x69, 0x63, 0x65, 0x2e, 0x4c, 0x6f, 0x63,
/// 0x61, 0x6c, 0x41, 0x67, 0x65, 0x6e, 0x74, 0x2e, 0x4d, 0x54, 0x50, 0x2e,
/// 0x31, 0x2e, 0x57, 0x65, 0x62, 0x53, 0x6f, 0x63, 0x6b, 0x65, 0x74, 0x2e,
/// 0x15, 0x62, 0x1b, 0x00, 0x00, 0x1a, 0x15, 0x55, 0x6e, 0x73, 0x75, 0x70,
/// 0x70, 0x6f, 0x72, 0x74, 0x65, 0x64, 0x20, 0x70, 0x61, 0x72, 0x61, 0x6d,
/// 0x65, 0x74, 0x65, 0x72
/// ])
/// .unwrap();
/// ```
pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
let this = try_decode_msg(bytes)?;
this.check_validity()?;
Ok(this)
}

/// Retrieves the message ID from a Msg structure
///
/// # Arguments
Expand Down Expand Up @@ -453,6 +486,39 @@ impl Msg {
}

impl Record {
/// Tries to decode a slice of bytes contained a Protobuf encoded USP Record
///
/// This function also performs additional checks required by the USP specification, see also
/// [`Record::check_validity`]
///
/// # Arguments
///
/// * `bytes` - A slice of bytes containing the Protobuf encoded USP Record
///
/// # Example
///
/// ```
/// use rusp::usp_record::Record;
/// let record =
/// Record::from_bytes(&[
/// 0x0a, 0x03, 0x31, 0x2e, 0x33, 0x12, 0x07, 0x64,
/// 0x6f, 0x63, 0x3a, 0x3a, 0x74, 0x6f, 0x1a, 0x09,
/// 0x64, 0x6f, 0x63, 0x3a, 0x3a, 0x66, 0x72, 0x6f,
/// 0x6d, 0x3a, 0x35, 0x12, 0x33, 0x0a, 0x07, 0x0a,
/// 0x03, 0x67, 0x65, 0x74, 0x10, 0x01, 0x12, 0x28,
/// 0x0a, 0x26, 0x0a, 0x24, 0x0a, 0x22, 0x44, 0x65,
/// 0x76, 0x69, 0x63, 0x65, 0x2e, 0x44, 0x65, 0x76,
/// 0x69, 0x63, 0x65, 0x49, 0x6e, 0x66, 0x6f, 0x2e,
/// 0x53, 0x6f, 0x66, 0x74, 0x77, 0x61, 0x72, 0x65,
/// 0x56, 0x65, 0x72, 0x73, 0x69, 0x6f, 0x6e, 0x2e,
/// ])
/// .unwrap();
/// ```
pub fn from_bytes(bytes: &[u8]) -> Result<Self> {
let this = try_decode_record(bytes)?;
this.check_validity()?;
Ok(this)
}
/// Checks the validity of this [`Record`] according to the USP specification
///
/// Although the type itself guarantees its validity against the protobuf schema, the USP
Expand Down Expand Up @@ -495,6 +561,31 @@ impl Record {
_ => Ok(()),
}
}

/// Flattens the payload of the [`Record`] and returns a mutable reference to it
///
/// This function will return [`None`] for both empty payloads and Record types that do not
/// contain a payload
pub fn payload_flatten(&mut self) -> Option<&mut Vec<u8>> {
use crate::usp_record::mod_Record::OneOfrecord_type;
use std::mem;

let flatten = match &mut self.record_type {
OneOfrecord_type::no_session_context(no_session) => Some(&mut no_session.payload),
OneOfrecord_type::session_context(session) => {
let flatten = if session.payload.len() == 1 {
&mut session.payload[0]
} else {
let old = mem::take(&mut session.payload);
session.payload = vec![old.into_iter().flatten().collect()];
&mut session.payload[0]
};
Some(flatten)
}
_ => None,
};
flatten.filter(|p| !p.is_empty())
}
}

#[cfg(test)]
Expand Down Expand Up @@ -562,4 +653,36 @@ mod tests {
.expect("msg_raw should be a valid USP Message according to the protobuf schema");
msg.check_validity().unwrap();
}

#[test]
fn flat_record() {
use crate::usp_record::mod_Record::OneOfrecord_type;

let raw = [
0x0a, 0x03, 0x31, 0x2e, 0x33, 0x12, 0x07, 0x64, 0x6f, 0x63, 0x3a, 0x3a, 0x74, 0x6f,
0x1a, 0x09, 0x64, 0x6f, 0x63, 0x3a, 0x3a, 0x66, 0x72, 0x6f, 0x6d, 0x42, 0x3c, 0x08,
0xd2, 0x09, 0x10, 0x01, 0x18, 0x02, 0x3a, 0x33, 0x0a, 0x07, 0x0a, 0x03, 0x67, 0x65,
0x74, 0x10, 0x01, 0x12, 0x28, 0x0a, 0x26, 0x0a, 0x24, 0x0a, 0x22, 0x44, 0x65, 0x76,
0x69, 0x63, 0x65, 0x2e, 0x44, 0x65, 0x76, 0x69, 0x63, 0x65, 0x49, 0x6e, 0x66, 0x6f,
0x2e, 0x53, 0x6f, 0x66, 0x74, 0x77, 0x61, 0x72, 0x65, 0x56, 0x65, 0x72, 0x73, 0x69,
0x6f, 0x6e, 0x2e,
];
let mut record = Record::from_bytes(&raw).expect("raw should be a valid Record");
let payload = record.payload_flatten().unwrap().clone();
assert!(!payload.is_empty());

let splitted = payload.chunks(2).map(Vec::from).collect::<Vec<_>>();
assert!(splitted.len() > 1);

let session = match &mut record.record_type {
OneOfrecord_type::session_context(session) => session,
_ => {
panic!("Record should be of type SessionContext");
}
};
session.payload = splitted;

let flatten = record.payload_flatten().unwrap();
assert_eq!(flatten, &payload);
}
}
31 changes: 27 additions & 4 deletions src/usp_encoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use crate::usp::Msg;
use crate::usp_record::Record;
use crate::usp_record::{Record, SessionContextRecord};

use anyhow::{Context, Result};

Expand Down Expand Up @@ -55,8 +55,31 @@ pub fn try_encode_msg(msg: &Msg) -> Result<Vec<u8>> {
msg.to_vec()
}

impl SessionContextRecord {
/// Creates a new [`SessionContextRecord`] with an unfragmented payload
pub fn new_unfragmented(
session_id: u64,
sequence_id: u64,
expected_id: u64,
retransmit_id: u64,
payload: Vec<u8>,
) -> Self {
use crate::usp_record::mod_SessionContextRecord::PayloadSARState;

Self {
session_id,
sequence_id,
expected_id,
retransmit_id,
payload_sar_state: PayloadSARState::NONE,
payloadrec_sar_state: PayloadSARState::NONE,
payload: vec![payload],
}
}
}

/// Implementation of some extension methods for `Record`s
impl<'a> Record {
impl Record {
/// Render the `Record` into JSON
///
/// # Arguments
Expand All @@ -77,7 +100,7 @@ impl<'a> Record {
/// ]).unwrap();
/// assert_eq!(record.to_json().unwrap(), "{\"version\":\"1.3\",\"to_id\":\"doc::to\",\"from_id\":\"doc::from\",\"payload_security\":\"PLAINTEXT\",\"mac_signature\":[],\"sender_cert\":[],\"mqtt_connect\":{\"version\":\"V5\",\"subscribed_topic\":\"topic\"}}");
/// ```
pub fn to_json(&'a self) -> Result<String> {
pub fn to_json(&self) -> Result<String> {
serde_json::to_string(self).context("Failed serializing USP Record to JSON")
}

Expand All @@ -101,7 +124,7 @@ impl<'a> Record {
/// ]).unwrap();
/// assert_eq!(record.to_json_pretty().unwrap(), "{\n \"version\": \"1.3\",\n \"to_id\": \"doc::to\",\n \"from_id\": \"doc::from\",\n \"payload_security\": \"PLAINTEXT\",\n \"mac_signature\": [],\n \"sender_cert\": [],\n \"mqtt_connect\": {\n \"version\": \"V5\",\n \"subscribed_topic\": \"topic\"\n }\n}");
/// ```
pub fn to_json_pretty(&'a self) -> Result<String> {
pub fn to_json_pretty(&self) -> Result<String> {
serde_json::to_string_pretty(self).context("Failed serializing USP Record to JSON")
}

Expand Down
Loading