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

/// Course Point message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
pub struct CoursePoint {
    pub message_index: typedef::MessageIndex,
    pub timestamp: typedef::DateTime,
    /// Units: semicircles
    pub position_lat: i32,
    /// Units: semicircles
    pub position_long: i32,
    /// Scale: 100; Units: m
    pub distance: u32,
    pub r#type: typedef::CoursePoint,
    pub name: String,
    pub favorite: typedef::Bool,
    /// 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 CoursePoint {
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::MessageIndex
    pub const MESSAGE_INDEX: u8 = 254;
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::DateTime
    pub const TIMESTAMP: u8 = 1;
    /// Value's type: `i32`; FitBaseType::SINT32; ProfileType::Sint32; Units: `semicircles`
    pub const POSITION_LAT: u8 = 2;
    /// Value's type: `i32`; FitBaseType::SINT32; ProfileType::Sint32; Units: `semicircles`
    pub const POSITION_LONG: u8 = 3;
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::Uint32; Scale: `100`; Units: `m`
    pub const DISTANCE: u8 = 4;
    /// Value's type: `u8`; FitBaseType::ENUM; ProfileType::CoursePoint
    pub const TYPE: u8 = 5;
    /// Value's type: `String`; FitBaseType::STRING; ProfileType::String
    pub const NAME: u8 = 6;
    /// Value's type: `u8`; FitBaseType::ENUM; ProfileType::Bool
    pub const FAVORITE: u8 = 8;

    /// Create new CoursePoint with all fields being set to its corresponding invalid value.
    pub const fn new() -> Self {
        Self {
            message_index: typedef::MessageIndex(u16::MAX),
            timestamp: typedef::DateTime(u32::MAX),
            position_lat: i32::MAX,
            position_long: i32::MAX,
            distance: u32::MAX,
            r#type: typedef::CoursePoint(u8::MAX),
            name: String::new(),
            favorite: typedef::Bool(u8::MAX),
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }

    /// Returns `position_lat` in degrees instead of semicircles. It returns `None` when value is invalid.
    pub fn position_lat_degrees(&self) -> Option<f64> {
        semconv::to_degrees(self.position_lat)
    }

    /// Set `position_lat` with a value in degrees instead of semicircles, the value will be converted to semicircles.
    pub fn set_position_lat_degrees(&mut self, v: f64) -> &mut Self {
        self.position_lat = semconv::to_semicircles(v).unwrap_or(i32::MAX);
        self
    }

    /// Returns `position_long` in degrees instead of semicircles. It returns `None` when value is invalid.
    pub fn position_long_degrees(&self) -> Option<f64> {
        semconv::to_degrees(self.position_long)
    }

    /// Set `position_long` with a value in degrees instead of semicircles, the value will be converted to semicircles.
    pub fn set_position_long_degrees(&mut self, v: f64) -> &mut Self {
        self.position_long = semconv::to_semicircles(v).unwrap_or(i32::MAX);
        self
    }

    /// Returns `distance` in its scaled value. It returns `None` when value is invalid.
    ///
    /// Units: m
    pub fn distance_scaled(&self) -> Option<f64> {
        if self.distance == u32::MAX {
            return None;
        }
        Some(self.distance as f64 / 100.0 - 0.0)
    }

    /// Set `distance` with scaled value, it will automatically be converted to its corresponding integer value.
    pub fn set_distance_scaled(&mut self, v: f64) -> &mut Self {
        let unscaled = (v + 0.0) * 100.0;
        if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u32::MAX as f64 {
            self.distance = u32::MAX;
            return self;
        }
        self.distance = unscaled as u32;
        self
    }

    fn count_valid_fields(&self) -> usize {
        (self.message_index.0 != u16::MAX) as usize
            + (self.timestamp.0 != u32::MAX) as usize
            + (self.position_lat != i32::MAX) as usize
            + (self.position_long != i32::MAX) as usize
            + (self.distance != u32::MAX) as usize
            + (self.r#type.0 != u8::MAX) as usize
            + (!self.name.is_empty()) as usize
            + (self.favorite.0 != u8::MAX) as usize
    }
}

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

impl From<&Message> for CoursePoint {
    /// from creates new CoursePoint struct based on given mesg.
    fn from(mesg: &Message) -> Self {
        const KNOWN_NUMS: [u64; 4] = [382, 0, 0, 4611686018427387904];
        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 {
                254 => v.message_index = typedef::MessageIndex(field.value.as_u16()),
                1 => v.timestamp = typedef::DateTime(field.value.as_u32()),
                2 => v.position_lat = field.value.as_i32(),
                3 => v.position_long = field.value.as_i32(),
                4 => v.distance = field.value.as_u32(),
                5 => v.r#type = typedef::CoursePoint(field.value.as_u8()),
                6 => v.name = field.value.as_str().to_owned(),
                8 => v.favorite = typedef::Bool(field.value.as_u8()),
                _ => v.unknown_fields.push(field.clone()),
            };
        }

        v
    }
}

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

        if m.message_index.0 != u16::MAX {
            fields.push(Field {
                num: 254,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.message_index.0),
                is_expanded: false,
            });
        };
        if m.timestamp.0 != u32::MAX {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT32,
                value: Value::Uint32(m.timestamp.0),
                is_expanded: false,
            });
        };
        if m.position_lat != i32::MAX {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::SINT32,
                value: Value::Int32(m.position_lat),
                is_expanded: false,
            });
        };
        if m.position_long != i32::MAX {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::SINT32,
                value: Value::Int32(m.position_long),
                is_expanded: false,
            });
        };
        if m.distance != u32::MAX {
            fields.push(Field {
                num: 4,
                base_type: FitBaseType::UINT32,
                value: Value::Uint32(m.distance),
                is_expanded: false,
            });
        };
        if m.r#type.0 != u8::MAX {
            fields.push(Field {
                num: 5,
                base_type: FitBaseType::ENUM,
                value: Value::Uint8(m.r#type.0),
                is_expanded: false,
            });
        };
        if !m.name.is_empty() {
            fields.push(Field {
                num: 6,
                base_type: FitBaseType::STRING,
                value: Value::String(m.name),
                is_expanded: false,
            });
        };
        if m.favorite.0 != u8::MAX {
            fields.push(Field {
                num: 8,
                base_type: FitBaseType::ENUM,
                value: Value::Uint8(m.favorite.0),
                is_expanded: false,
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

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

#[cfg(feature = "serde")]
impl Serialize for CoursePoint {
    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("CoursePoint", n)?;
        if self.message_index.0 != u16::MAX {
            state.serialize_field("message_index", &self.message_index)?;
        }
        if let Some(v) = self.timestamp.unix_timestamp() {
            state.serialize_field("timestamp", &v)?;
        }
        if let Some(v) = self.position_lat_degrees() {
            state.serialize_field("position_lat", &v)?;
        }
        if let Some(v) = self.position_long_degrees() {
            state.serialize_field("position_long", &v)?;
        }
        if let Some(v) = self.distance_scaled() {
            state.serialize_field("distance", &v)?;
        }
        if self.r#type.0 != u8::MAX {
            state.serialize_field("type", &self.r#type)?;
        }
        if !self.name.is_empty() {
            state.serialize_field("name", &self.name)?;
        }
        if self.favorite.0 != u8::MAX {
            state.serialize_field("favorite", &self.favorite)?;
        }
        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 {
    message_index: typedef::MessageIndex,
    timestamp: Option<i64>,
    /// Degrees.
    position_lat: f64,
    /// Degrees.
    position_long: f64,
    distance: f64,
    r#type: typedef::CoursePoint,
    name: String,
    favorite: typedef::Bool,
    unknown_fields: Vec<Field>,
    developer_fields: Vec<DeveloperField>,
}

#[cfg(feature = "serde")]
impl From<De> for CoursePoint {
    fn from(m: De) -> Self {
        Self {
            message_index: m.message_index,
            timestamp: m.timestamp.map_or_else(
                || typedef::DateTime(u32::MAX),
                typedef::DateTime::from_unix_timestamp,
            ),
            position_lat: semconv::to_semicircles(m.position_lat).unwrap_or(i32::MAX),
            position_long: semconv::to_semicircles(m.position_long).unwrap_or(i32::MAX),
            distance: {
                let unscaled = (m.distance + 0.0) * 100.0;
                if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u32::MAX as f64 {
                    u32::MAX
                } else {
                    unscaled as u32
                }
            },
            r#type: m.r#type,
            name: m.name,
            favorite: m.favorite,
            unknown_fields: m.unknown_fields,
            developer_fields: m.developer_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Default for De {
    fn default() -> Self {
        Self {
            message_index: typedef::MessageIndex(u16::MAX),
            timestamp: None,
            position_lat: f64::from_bits(u64::MAX),
            position_long: f64::from_bits(u64::MAX),
            distance: f64::from_bits(u64::MAX),
            r#type: typedef::CoursePoint(u8::MAX),
            name: String::new(),
            favorite: typedef::Bool(u8::MAX),
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }
}