Skip to content

feat(types): Add TBF header serialization support with set_flags function #109

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

Open
thoguii wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(types): Add TBF header serialization support with set_flags function #109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
847d9c5
feat: add set_flags function with serialization support
thoguii Oct 1, 2025
8430e23
fix(types): removed unsued pub function, followed the suggestions
thoguii Oct 2, 2025
208fc14
feat(types): add setters for enable and sticky application's flags
thoguii Oct 6, 2025
9561750
fix(): ran
thoguii Oct 6, 2025
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
54 changes: 17 additions & 37 deletions tbf-parser/src/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1184,6 +1184,8 @@ impl TbfHeader {
}
}

/// Returns the checksum for TBF header according to the `parse_tbf_header` function
/// `new_flags` is the new value we want to set
pub fn compute_checksum(header: &[u8], new_flags: u32) -> Result<u32, TbfParseError> {
let mut checksum: u32 = 0;

Expand All @@ -1203,7 +1205,8 @@ impl TbfHeader {
Ok(checksum)
}

pub fn set_flags(&mut self, flags: u32, header: &[u8]) -> Result<[u8; 16], TbfParseError> {
/// Sets the flag field and updates the checksum, it modifies the state accordingly
pub fn set_flags(&mut self, flags: u32, header: &[u8]) -> Result<(), TbfParseError> {

@eva-cosma eva-cosma Oct 6, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides this function, I would create a

  • set_enabled
  • set_sticky

and anything else the flags can be. Just so that the end-user of this crate does not need to know which bit is the 'enabled' or 'sticky' bit

let new_checksum = Self::compute_checksum(header, flags)?;
match self {
TbfHeader::TbfHeaderV2(hd) => {
Expand All @@ -1216,44 +1219,21 @@ impl TbfHeader {
}
}

self.serialize()
Ok(())
}

/// Returns a 16 byte array with the serialized base header (little-endian format)
pub fn serialize(&self) -> Result<[u8; 16], TbfParseError> {
match self {
TbfHeader::TbfHeaderV2(hd) => {
let base = &hd.base;
let mut bytes = [0u8; 16];
bytes[0..2].copy_from_slice(&base.version.to_le_bytes());
bytes[2..4].copy_from_slice(&base.header_size.to_le_bytes());
bytes[4..8].copy_from_slice(&base.total_size.to_le_bytes());
bytes[8..12].copy_from_slice(&base.flags.to_le_bytes());
bytes[12..16].copy_from_slice(&base.checksum.to_le_bytes());
Ok(bytes)
}
TbfHeader::Padding(base) => {
let mut bytes = [0u8; 16];
bytes[0..2].copy_from_slice(&base.version.to_le_bytes());
bytes[2..4].copy_from_slice(&base.header_size.to_le_bytes());
bytes[4..8].copy_from_slice(&base.total_size.to_le_bytes());
bytes[8..12].copy_from_slice(&base.flags.to_le_bytes());
bytes[12..16].copy_from_slice(&base.checksum.to_le_bytes());
Ok(bytes)
}
}
}

pub fn update_from_serialize(&mut self, bytes: &[u8]) -> Result<(), TbfParseError> {
let new_base = TbfHeaderV2Base::try_from(&bytes[..])?;
match self {
TbfHeader::TbfHeaderV2(hd) => {
hd.base = new_base;
Ok(())
}
TbfHeader::Padding(base) => {
*base = new_base;
Ok(())
}
}
let base = match self {
TbfHeader::TbfHeaderV2(hd) => &hd.base,
TbfHeader::Padding(base) => base,
};
let mut bytes = [0u8; 16];
bytes[0..2].copy_from_slice(&base.version.to_le_bytes());
bytes[2..4].copy_from_slice(&base.header_size.to_le_bytes());
bytes[4..8].copy_from_slice(&base.total_size.to_le_bytes());
bytes[8..12].copy_from_slice(&base.flags.to_le_bytes());
bytes[12..16].copy_from_slice(&base.checksum.to_le_bytes());
Ok(bytes)
}
}
Loading