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.

#![allow(clippy::manual_range_patterns)]

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

fn is_expanded(state: &[u8], num: u8) -> bool {
    match num {
        2 | 3 | 4 => (state[num as usize >> 3] >> (num & 7)) & 1 == 1,
        _ => false,
    }
}

/// Raw Bbi message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
pub struct RawBbi {
    pub timestamp: typedef::DateTime,
    /// Units: ms; Millisecond resolution of the timestamp
    pub timestamp_ms: u16,
    /// 1 bit for gap indicator, 1 bit for quality indicator, and 14 bits for Beat-to-Beat interval values in whole-integer millisecond resolution
    pub data: Vec<u16>,
    /// Units: ms; Array of millisecond times between beats
    pub time: Vec<u16>,
    /// 1 = high confidence. 0 = low confidence. N/A when gap = 1
    pub quality: Vec<u8>,
    /// 1 = gap (time represents ms gap length). 0 = BBI data
    pub gap: Vec<u8>,
    state: [u8; 1], // Used for tracking expanded fields.
    /// 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 RawBbi {
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::DateTime
    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
    pub const DATA: u8 = 1;
    /// Value's type: `Vec<u16>`; FitBaseType::UINT16; ProfileType::Uint16; Units: `ms`
    pub const TIME: u8 = 2;
    /// Value's type: `Vec<u8>`; FitBaseType::UINT8; ProfileType::Uint8
    pub const QUALITY: u8 = 3;
    /// Value's type: `Vec<u8>`; FitBaseType::UINT8; ProfileType::Uint8
    pub const GAP: u8 = 4;

    /// Create new RawBbi 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,
            data: Vec::new(),
            time: Vec::new(),
            quality: Vec::new(),
            gap: Vec::new(),
            state: [0u8; 1],
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }

    /// Marks whether given field's num is an expanded field (field that being generated through a component expansion).
    pub fn mark_as_expanded(&mut self, num: u8, flag: bool) -> bool {
        match num {
            2 | 3 | 4 => {
                if flag {
                    self.state[num as usize >> 3] |= 1 << (num & 7)
                } else {
                    self.state[num as usize >> 3] &= !(1 << (num & 7))
                }
                true
            }
            _ => false,
        }
    }

    /// checks whether given field's num is a field generated through a component expansion.
    pub fn is_expanded(&self, num: u8) -> bool {
        is_expanded(&self.state, num)
    }

    fn count_valid_fields(&self) -> usize {
        (self.timestamp.0 != u32::MAX) as usize
            + (self.timestamp_ms != u16::MAX) as usize
            + (!self.data.is_empty()) as usize
            + (!self.time.is_empty()) as usize
            + (!self.quality.is_empty()) as usize
            + (!self.gap.is_empty()) as usize
    }
}

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

impl From<&Message> for RawBbi {
    /// from creates new RawBbi struct based on given mesg.
    fn from(mesg: &Message) -> Self {
        const KNOWN_NUMS: [u64; 4] = [31, 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.data = field.value.to_vec_u16(),
                2 => v.time = field.value.to_vec_u16(),
                3 => v.quality = field.value.to_vec_u8(),
                4 => v.gap = field.value.to_vec_u8(),
                _ => {
                    v.unknown_fields.push(field.clone());
                    continue;
                }
            };
            if field.is_expanded && field.num < 5 {
                v.state[field.num as usize >> 3] |= 1 << (field.num & 7)
            }
        }

        v
    }
}

impl From<RawBbi> for Message {
    fn from(m: RawBbi) -> 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.data.is_empty() {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT16,
                value: Value::VecUint16(m.data),
                is_expanded: false,
            });
        };
        if !m.time.is_empty() {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::UINT16,
                value: Value::VecUint16(m.time),
                is_expanded: is_expanded(&m.state, 2),
            });
        };
        if !m.quality.is_empty() {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::UINT8,
                value: Value::VecUint8(m.quality),
                is_expanded: is_expanded(&m.state, 3),
            });
        };
        if !m.gap.is_empty() {
            fields.push(Field {
                num: 4,
                base_type: FitBaseType::UINT8,
                value: Value::VecUint8(m.gap),
                is_expanded: is_expanded(&m.state, 4),
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

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

#[cfg(feature = "serde")]
impl Serialize for RawBbi {
    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("RawBbi", 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.data.is_empty() {
            state.serialize_field("data", &self.data)?;
        }
        if !self.time.is_empty() {
            state.serialize_field("time", &self.time)?;
        }
        if !self.quality.is_empty() {
            state.serialize_field("quality", &self.quality)?;
        }
        if !self.gap.is_empty() {
            state.serialize_field("gap", &self.gap)?;
        }
        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,
    data: Vec<u16>,
    time: Vec<u16>,
    quality: Vec<u8>,
    gap: Vec<u8>,
    unknown_fields: Vec<Field>,
    developer_fields: Vec<DeveloperField>,
}

#[cfg(feature = "serde")]
impl From<De> for RawBbi {
    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,
            data: m.data,
            time: m.time,
            quality: m.quality,
            gap: m.gap,
            state: [0u8; 1],
            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,
            data: Vec::new(),
            time: Vec::new(),
            quality: Vec::new(),
            gap: Vec::new(),
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }
}