Enum palmrs_database::record::pdb_record::PdbRecordHeader

pub enum PdbRecordHeader {
    Record {
        attributes: RecordAttributes,
        unique_id: u32,
        data_offset: u32,
        data_len: Option<u32>,
    },
    Resource {
        name: [u8; 4],
        record_id: u16,
        data_offset: u32,
        data_len: Option<u32>,
    },
}

Generic Palm database record header

This type can represent either a “record” or a “resource” within a Palm OS database:

• Records are potentially-mutable entries that are used in PDB databases to represent content;
• Resources are generally-immutable data entries that are used, as the name would suggest, for application resources, and are found within PRC files.

Which type to use to decode a given record header should be determined by the lowest bit in the attributes field of the DatabaseHeader for this record’s containing database - if that bit is cleared, “records” are used; if it is set, “resources” are used.

These two types are presented as an enum for the sake of flexibility, and to allow sharing encoding/decoding code between the two available record header types.

Variants

Record

Fields

attributes: RecordAttributes

unique_id: u32

data_offset: u32

data_len: Option<u32>

Resource

Fields

name: [u8; 4]

record_id: u16

data_offset: u32

data_len: Option<u32>

Trait Implementations

impl Clone for PdbRecordHeader

fn clone(&self) -> PdbRecordHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DatabaseRecord for PdbRecordHeader

fn from_bytes( hdr: &DatabaseHeader, rdr: &mut Cursor<&[u8]> ) -> Result<Self, Error>

Read the record header from the given byte array

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Write the record header to a new Vec<u8>

fn name_str(&self) -> Option<&str>

Return the record’s name, if known

fn attributes(&self) -> Option<RecordAttributes>

Return the record’s attributes, if known

fn data_len(&self) -> Option<u32>

Return the length of the record’s data, if known

fn unique_id(&self) -> Option<u32>

Return the unique id if the record is not a resource

fn resource_id(&self) -> Option<u16>

Return the resource id if the record is a resource

fn construct_record( attributes: RecordAttributes, unique_id: u32, data_offset: u32, data_len: Option<u32> ) -> Self

Construct a record with the given parameters

fn construct_resource( name: &[u8; 4], record_id: u16, data_offset: u32, data_len: Option<u32> ) -> Self

Construct a resource with the given parameters

impl Debug for PdbRecordHeader

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

Formats the value using the given formatter.

impl PartialEq<PdbRecordHeader> for PdbRecordHeader

fn eq(&self, other: &PdbRecordHeader) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PdbRecordHeader

impl StructuralPartialEq for PdbRecordHeader