rustyfit 0.10.0

The #![no_std] Rust implementation of The Flexible and Interoperable Data Transfer (FIT) Protocol for decoding and encoding Garmin FIT files, supporting FIT Protocol V2.
Documentation
// Code generated by fitgen/main.go. DO NOT EDIT.

// Copyright 2025 The RustyFIT Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

use crate::profile::typedef::{self, FitBaseType};
use crate::proto::*;
use alloc::vec::Vec;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize, Serializer, ser::SerializeStruct};

/// Obdii Data message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
pub struct ObdiiData {
    /// Units: s; Timestamp message was output
    pub timestamp: typedef::DateTime,
    /// Units: ms; Fractional part of timestamp, added to timestamp
    pub timestamp_ms: u16,
    /// Units: ms; Offset of PID reading \[i\] from start_timestamp+start_timestamp_ms. Readings may span across seconds.
    pub time_offset: Vec<u16>,
    /// Parameter ID
    pub pid: u8,
    /// Raw parameter data
    pub raw_data: Vec<u8>,
    /// Optional, data size of PID\[i\]. If not specified refer to SAE J1979.
    pub pid_data_size: Vec<u8>,
    /// System time associated with sample expressed in ms, can be used instead of time_offset. There will be a system_time value for each raw_data element. For multibyte pids the system_time is repeated.
    pub system_time: Vec<u32>,
    /// Timestamp of first sample recorded in the message. Used with time_offset to generate time of each sample
    pub start_timestamp: typedef::DateTime,
    /// Units: ms; Fractional part of start_timestamp
    pub start_timestamp_ms: u16,
    /// unknown_fields are fields that are exist but they are not defined in Profile.xlsx
    pub unknown_fields: Vec<Field>,
    /// developer_fields are custom data fields (Added since protocol version 2.0)
    pub developer_fields: Vec<DeveloperField>,
}

impl ObdiiData {
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::DateTime; Units: `s`
    pub const TIMESTAMP: u8 = 253;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::Uint16; Units: `ms`
    pub const TIMESTAMP_MS: u8 = 0;
    /// Value's type: `Vec<u16>`; FitBaseType::UINT16; ProfileType::Uint16; Units: `ms`
    pub const TIME_OFFSET: u8 = 1;
    /// Value's type: `u8`; FitBaseType::BYTE; ProfileType::Byte
    pub const PID: u8 = 2;
    /// Value's type: `Vec<u8>`; FitBaseType::BYTE; ProfileType::Byte
    pub const RAW_DATA: u8 = 3;
    /// Value's type: `Vec<u8>`; FitBaseType::UINT8; ProfileType::Uint8
    pub const PID_DATA_SIZE: u8 = 4;
    /// Value's type: `Vec<u32>`; FitBaseType::UINT32; ProfileType::Uint32
    pub const SYSTEM_TIME: u8 = 5;
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::DateTime
    pub const START_TIMESTAMP: u8 = 6;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::Uint16; Units: `ms`
    pub const START_TIMESTAMP_MS: u8 = 7;

    /// Create new ObdiiData with all fields being set to its corresponding invalid value.
    pub const fn new() -> Self {
        Self {
            timestamp: typedef::DateTime(u32::MAX),
            timestamp_ms: u16::MAX,
            time_offset: Vec::new(),
            pid: u8::MAX,
            raw_data: Vec::new(),
            pid_data_size: Vec::new(),
            system_time: Vec::new(),
            start_timestamp: typedef::DateTime(u32::MAX),
            start_timestamp_ms: u16::MAX,
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }

    fn count_valid_fields(&self) -> usize {
        (self.timestamp.0 != u32::MAX) as usize
            + (self.timestamp_ms != u16::MAX) as usize
            + (!self.time_offset.is_empty()) as usize
            + (self.pid != u8::MAX) as usize
            + (!self.raw_data.is_empty()) as usize
            + (!self.pid_data_size.is_empty()) as usize
            + (!self.system_time.is_empty()) as usize
            + (self.start_timestamp.0 != u32::MAX) as usize
            + (self.start_timestamp_ms != u16::MAX) as usize
    }
}

impl Default for ObdiiData {
    fn default() -> Self {
        Self::new()
    }
}

impl From<&Message> for ObdiiData {
    /// from creates new ObdiiData struct based on given mesg.
    fn from(mesg: &Message) -> Self {
        const KNOWN_NUMS: [u64; 4] = [255, 0, 0, 2305843009213693952];
        let mut n = 0u64;
        for field in &mesg.fields {
            n += (KNOWN_NUMS[field.num as usize >> 6] >> (field.num & 63)) & 1 ^ 1
        }

        let mut v = Self::new();
        v.unknown_fields = Vec::<Field>::with_capacity(n as usize);
        v.developer_fields = mesg.developer_fields.clone();

        for field in &mesg.fields {
            match field.num {
                253 => v.timestamp = typedef::DateTime(field.value.as_u32()),
                0 => v.timestamp_ms = field.value.as_u16(),
                1 => v.time_offset = field.value.to_vec_u16(),
                2 => v.pid = field.value.as_u8(),
                3 => v.raw_data = field.value.to_vec_u8(),
                4 => v.pid_data_size = field.value.to_vec_u8(),
                5 => v.system_time = field.value.to_vec_u32(),
                6 => v.start_timestamp = typedef::DateTime(field.value.as_u32()),
                7 => v.start_timestamp_ms = field.value.as_u16(),
                _ => v.unknown_fields.push(field.clone()),
            };
        }

        v
    }
}

impl From<ObdiiData> for Message {
    fn from(m: ObdiiData) -> Self {
        let mut fields =
            Vec::<Field>::with_capacity(m.count_valid_fields() + m.unknown_fields.len());

        if m.timestamp.0 != u32::MAX {
            fields.push(Field {
                num: 253,
                base_type: FitBaseType::UINT32,
                value: Value::Uint32(m.timestamp.0),
                is_expanded: false,
            });
        };
        if m.timestamp_ms != u16::MAX {
            fields.push(Field {
                num: 0,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.timestamp_ms),
                is_expanded: false,
            });
        };
        if !m.time_offset.is_empty() {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT16,
                value: Value::VecUint16(m.time_offset),
                is_expanded: false,
            });
        };
        if m.pid != u8::MAX {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::BYTE,
                value: Value::Uint8(m.pid),
                is_expanded: false,
            });
        };
        if !m.raw_data.is_empty() {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::BYTE,
                value: Value::VecUint8(m.raw_data),
                is_expanded: false,
            });
        };
        if !m.pid_data_size.is_empty() {
            fields.push(Field {
                num: 4,
                base_type: FitBaseType::UINT8,
                value: Value::VecUint8(m.pid_data_size),
                is_expanded: false,
            });
        };
        if !m.system_time.is_empty() {
            fields.push(Field {
                num: 5,
                base_type: FitBaseType::UINT32,
                value: Value::VecUint32(m.system_time),
                is_expanded: false,
            });
        };
        if m.start_timestamp.0 != u32::MAX {
            fields.push(Field {
                num: 6,
                base_type: FitBaseType::UINT32,
                value: Value::Uint32(m.start_timestamp.0),
                is_expanded: false,
            });
        };
        if m.start_timestamp_ms != u16::MAX {
            fields.push(Field {
                num: 7,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.start_timestamp_ms),
                is_expanded: false,
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

        Self {
            header: 0,
            num: typedef::MesgNum::OBDII_DATA,
            fields,
            developer_fields: m.developer_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Serialize for ObdiiData {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let n = self.count_valid_fields() + 2;
        let mut state = serializer.serialize_struct("ObdiiData", n)?;
        if let Some(v) = self.timestamp.unix_timestamp() {
            state.serialize_field("timestamp", &v)?;
        }
        if self.timestamp_ms != u16::MAX {
            state.serialize_field("timestamp_ms", &self.timestamp_ms)?;
        }
        if !self.time_offset.is_empty() {
            state.serialize_field("time_offset", &self.time_offset)?;
        }
        if self.pid != u8::MAX {
            state.serialize_field("pid", &self.pid)?;
        }
        if !self.raw_data.is_empty() {
            state.serialize_field("raw_data", &self.raw_data)?;
        }
        if !self.pid_data_size.is_empty() {
            state.serialize_field("pid_data_size", &self.pid_data_size)?;
        }
        if !self.system_time.is_empty() {
            state.serialize_field("system_time", &self.system_time)?;
        }
        if let Some(v) = self.start_timestamp.unix_timestamp() {
            state.serialize_field("start_timestamp", &v)?;
        }
        if self.start_timestamp_ms != u16::MAX {
            state.serialize_field("start_timestamp_ms", &self.start_timestamp_ms)?;
        }
        if !self.unknown_fields.is_empty() {
            state.serialize_field("unknown_fields", &self.unknown_fields)?;
        }
        if !self.developer_fields.is_empty() {
            state.serialize_field("developer_fields", &self.developer_fields)?;
        }
        state.end()
    }
}

#[cfg(feature = "serde")]
#[cfg_attr(feature = "serde", derive(Deserialize), serde(default))]
struct De {
    timestamp: Option<i64>,
    timestamp_ms: u16,
    time_offset: Vec<u16>,
    pid: u8,
    raw_data: Vec<u8>,
    pid_data_size: Vec<u8>,
    system_time: Vec<u32>,
    start_timestamp: Option<i64>,
    start_timestamp_ms: u16,
    unknown_fields: Vec<Field>,
    developer_fields: Vec<DeveloperField>,
}

#[cfg(feature = "serde")]
impl From<De> for ObdiiData {
    fn from(m: De) -> Self {
        Self {
            timestamp: m.timestamp.map_or_else(
                || typedef::DateTime(u32::MAX),
                typedef::DateTime::from_unix_timestamp,
            ),
            timestamp_ms: m.timestamp_ms,
            time_offset: m.time_offset,
            pid: m.pid,
            raw_data: m.raw_data,
            pid_data_size: m.pid_data_size,
            system_time: m.system_time,
            start_timestamp: m.start_timestamp.map_or_else(
                || typedef::DateTime(u32::MAX),
                typedef::DateTime::from_unix_timestamp,
            ),
            start_timestamp_ms: m.start_timestamp_ms,
            unknown_fields: m.unknown_fields,
            developer_fields: m.developer_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Default for De {
    fn default() -> Self {
        Self {
            timestamp: None,
            timestamp_ms: u16::MAX,
            time_offset: Vec::new(),
            pid: u8::MAX,
            raw_data: Vec::new(),
            pid_data_size: Vec::new(),
            system_time: Vec::new(),
            start_timestamp: None,
            start_timestamp_ms: u16::MAX,
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }
}