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::borrow::ToOwned;
use alloc::string::String;
use alloc::vec::Vec;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize, Serializer, ser::SerializeStruct};

/// Field Description message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
pub struct FieldDescription {
    pub developer_data_index: u8,
    pub field_definition_number: u8,
    pub fit_base_type_id: typedef::FitBaseType,
    pub field_name: Vec<String>,
    pub array: u8,
    pub components: String,
    pub scale: u8,
    pub offset: i8,
    pub units: Vec<String>,
    pub bits: String,
    pub accumulate: String,
    pub fit_base_unit_id: typedef::FitBaseUnit,
    pub native_mesg_num: typedef::MesgNum,
    pub native_field_num: u8,
    /// unknown_fields are fields that are exist but they are not defined in Profile.xlsx
    pub unknown_fields: Vec<Field>,
}

impl FieldDescription {
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const DEVELOPER_DATA_INDEX: u8 = 0;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const FIELD_DEFINITION_NUMBER: u8 = 1;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::FitBaseType
    pub const FIT_BASE_TYPE_ID: u8 = 2;
    /// Value's type: `Vec<String>`; FitBaseType::STRING; ProfileType::String
    pub const FIELD_NAME: u8 = 3;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const ARRAY: u8 = 4;
    /// Value's type: `String`; FitBaseType::STRING; ProfileType::String
    pub const COMPONENTS: u8 = 5;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const SCALE: u8 = 6;
    /// Value's type: `i8`; FitBaseType::SINT8; ProfileType::Sint8
    pub const OFFSET: u8 = 7;
    /// Value's type: `Vec<String>`; FitBaseType::STRING; ProfileType::String
    pub const UNITS: u8 = 8;
    /// Value's type: `String`; FitBaseType::STRING; ProfileType::String
    pub const BITS: u8 = 9;
    /// Value's type: `String`; FitBaseType::STRING; ProfileType::String
    pub const ACCUMULATE: u8 = 10;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::FitBaseUnit
    pub const FIT_BASE_UNIT_ID: u8 = 13;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::MesgNum
    pub const NATIVE_MESG_NUM: u8 = 14;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const NATIVE_FIELD_NUM: u8 = 15;

    /// Create new FieldDescription with all fields being set to its corresponding invalid value.
    pub const fn new() -> Self {
        Self {
            developer_data_index: u8::MAX,
            field_definition_number: u8::MAX,
            fit_base_type_id: typedef::FitBaseType(u8::MAX),
            field_name: Vec::new(),
            array: u8::MAX,
            components: String::new(),
            scale: u8::MAX,
            offset: i8::MAX,
            units: Vec::new(),
            bits: String::new(),
            accumulate: String::new(),
            fit_base_unit_id: typedef::FitBaseUnit(u16::MAX),
            native_mesg_num: typedef::MesgNum(u16::MAX),
            native_field_num: u8::MAX,
            unknown_fields: Vec::new(),
        }
    }

    fn count_valid_fields(&self) -> usize {
        (self.developer_data_index != u8::MAX) as usize
            + (self.field_definition_number != u8::MAX) as usize
            + (self.fit_base_type_id.0 != u8::MAX) as usize
            + (!self.field_name.is_empty()) as usize
            + (self.array != u8::MAX) as usize
            + (!self.components.is_empty()) as usize
            + (self.scale != u8::MAX) as usize
            + (self.offset != i8::MAX) as usize
            + (!self.units.is_empty()) as usize
            + (!self.bits.is_empty()) as usize
            + (!self.accumulate.is_empty()) as usize
            + (self.fit_base_unit_id.0 != u16::MAX) as usize
            + (self.native_mesg_num.0 != u16::MAX) as usize
            + (self.native_field_num != u8::MAX) as usize
    }
}

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

impl From<&Message> for FieldDescription {
    /// from creates new FieldDescription struct based on given mesg.
    fn from(mesg: &Message) -> Self {
        const KNOWN_NUMS: [u64; 4] = [59391, 0, 0, 0];
        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);

        for field in &mesg.fields {
            match field.num {
                0 => v.developer_data_index = field.value.as_u8(),
                1 => v.field_definition_number = field.value.as_u8(),
                2 => v.fit_base_type_id = typedef::FitBaseType(field.value.as_u8()),
                3 => v.field_name = field.value.to_vec_string(),
                4 => v.array = field.value.as_u8(),
                5 => v.components = field.value.as_str().to_owned(),
                6 => v.scale = field.value.as_u8(),
                7 => v.offset = field.value.as_i8(),
                8 => v.units = field.value.to_vec_string(),
                9 => v.bits = field.value.as_str().to_owned(),
                10 => v.accumulate = field.value.as_str().to_owned(),
                13 => v.fit_base_unit_id = typedef::FitBaseUnit(field.value.as_u16()),
                14 => v.native_mesg_num = typedef::MesgNum(field.value.as_u16()),
                15 => v.native_field_num = field.value.as_u8(),
                _ => v.unknown_fields.push(field.clone()),
            };
        }

        v
    }
}

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

        if m.developer_data_index != u8::MAX {
            fields.push(Field {
                num: 0,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.developer_data_index),
                is_expanded: false,
            });
        };
        if m.field_definition_number != u8::MAX {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.field_definition_number),
                is_expanded: false,
            });
        };
        if m.fit_base_type_id.0 != u8::MAX {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.fit_base_type_id.0),
                is_expanded: false,
            });
        };
        if !m.field_name.is_empty() {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::STRING,
                value: Value::VecString(m.field_name),
                is_expanded: false,
            });
        };
        if m.array != u8::MAX {
            fields.push(Field {
                num: 4,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.array),
                is_expanded: false,
            });
        };
        if !m.components.is_empty() {
            fields.push(Field {
                num: 5,
                base_type: FitBaseType::STRING,
                value: Value::String(m.components),
                is_expanded: false,
            });
        };
        if m.scale != u8::MAX {
            fields.push(Field {
                num: 6,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.scale),
                is_expanded: false,
            });
        };
        if m.offset != i8::MAX {
            fields.push(Field {
                num: 7,
                base_type: FitBaseType::SINT8,
                value: Value::Int8(m.offset),
                is_expanded: false,
            });
        };
        if !m.units.is_empty() {
            fields.push(Field {
                num: 8,
                base_type: FitBaseType::STRING,
                value: Value::VecString(m.units),
                is_expanded: false,
            });
        };
        if !m.bits.is_empty() {
            fields.push(Field {
                num: 9,
                base_type: FitBaseType::STRING,
                value: Value::String(m.bits),
                is_expanded: false,
            });
        };
        if !m.accumulate.is_empty() {
            fields.push(Field {
                num: 10,
                base_type: FitBaseType::STRING,
                value: Value::String(m.accumulate),
                is_expanded: false,
            });
        };
        if m.fit_base_unit_id.0 != u16::MAX {
            fields.push(Field {
                num: 13,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.fit_base_unit_id.0),
                is_expanded: false,
            });
        };
        if m.native_mesg_num.0 != u16::MAX {
            fields.push(Field {
                num: 14,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.native_mesg_num.0),
                is_expanded: false,
            });
        };
        if m.native_field_num != u8::MAX {
            fields.push(Field {
                num: 15,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.native_field_num),
                is_expanded: false,
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

        Self {
            header: 0,
            num: typedef::MesgNum::FIELD_DESCRIPTION,
            fields,
            developer_fields: Vec::new(),
        }
    }
}

#[cfg(feature = "serde")]
impl Serialize for FieldDescription {
    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("FieldDescription", n)?;
        if self.developer_data_index != u8::MAX {
            state.serialize_field("developer_data_index", &self.developer_data_index)?;
        }
        if self.field_definition_number != u8::MAX {
            state.serialize_field("field_definition_number", &self.field_definition_number)?;
        }
        if self.fit_base_type_id.0 != u8::MAX {
            state.serialize_field("fit_base_type_id", &self.fit_base_type_id)?;
        }
        if !self.field_name.is_empty() {
            state.serialize_field("field_name", &self.field_name)?;
        }
        if self.array != u8::MAX {
            state.serialize_field("array", &self.array)?;
        }
        if !self.components.is_empty() {
            state.serialize_field("components", &self.components)?;
        }
        if self.scale != u8::MAX {
            state.serialize_field("scale", &self.scale)?;
        }
        if self.offset != i8::MAX {
            state.serialize_field("offset", &self.offset)?;
        }
        if !self.units.is_empty() {
            state.serialize_field("units", &self.units)?;
        }
        if !self.bits.is_empty() {
            state.serialize_field("bits", &self.bits)?;
        }
        if !self.accumulate.is_empty() {
            state.serialize_field("accumulate", &self.accumulate)?;
        }
        if self.fit_base_unit_id.0 != u16::MAX {
            state.serialize_field("fit_base_unit_id", &self.fit_base_unit_id)?;
        }
        if self.native_mesg_num.0 != u16::MAX {
            state.serialize_field("native_mesg_num", &self.native_mesg_num)?;
        }
        if self.native_field_num != u8::MAX {
            state.serialize_field("native_field_num", &self.native_field_num)?;
        }
        if !self.unknown_fields.is_empty() {
            state.serialize_field("unknown_fields", &self.unknown_fields)?;
        }
        state.end()
    }
}

#[cfg(feature = "serde")]
#[cfg_attr(feature = "serde", derive(Deserialize), serde(default))]
struct De {
    developer_data_index: u8,
    field_definition_number: u8,
    fit_base_type_id: typedef::FitBaseType,
    field_name: Vec<String>,
    array: u8,
    components: String,
    scale: u8,
    offset: i8,
    units: Vec<String>,
    bits: String,
    accumulate: String,
    fit_base_unit_id: typedef::FitBaseUnit,
    native_mesg_num: typedef::MesgNum,
    native_field_num: u8,
    unknown_fields: Vec<Field>,
}

#[cfg(feature = "serde")]
impl From<De> for FieldDescription {
    fn from(m: De) -> Self {
        Self {
            developer_data_index: m.developer_data_index,
            field_definition_number: m.field_definition_number,
            fit_base_type_id: m.fit_base_type_id,
            field_name: m.field_name,
            array: m.array,
            components: m.components,
            scale: m.scale,
            offset: m.offset,
            units: m.units,
            bits: m.bits,
            accumulate: m.accumulate,
            fit_base_unit_id: m.fit_base_unit_id,
            native_mesg_num: m.native_mesg_num,
            native_field_num: m.native_field_num,
            unknown_fields: m.unknown_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Default for De {
    fn default() -> Self {
        Self {
            developer_data_index: u8::MAX,
            field_definition_number: u8::MAX,
            fit_base_type_id: typedef::FitBaseType(u8::MAX),
            field_name: Vec::new(),
            array: u8::MAX,
            components: String::new(),
            scale: u8::MAX,
            offset: i8::MAX,
            units: Vec::new(),
            bits: String::new(),
            accumulate: String::new(),
            fit_base_unit_id: typedef::FitBaseUnit(u16::MAX),
            native_mesg_num: typedef::MesgNum(u16::MAX),
            native_field_num: u8::MAX,
            unknown_fields: Vec::new(),
        }
    }
}