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};

/// Tank Summary message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
pub struct TankSummary {
    /// Units: s
    pub timestamp: typedef::DateTime,
    /// Base: UINT32Z
    pub sensor: typedef::AntChannelId,
    /// Scale: 100; Units: bar
    pub start_pressure: u16,
    /// Scale: 100; Units: bar
    pub end_pressure: u16,
    /// Scale: 100; Units: L
    pub volume_used: u32,
    /// 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 TankSummary {
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::DateTime; Units: `s`
    pub const TIMESTAMP: u8 = 253;
    /// Value's type: `u32`; FitBaseType::UINT32Z; ProfileType::AntChannelId
    pub const SENSOR: u8 = 0;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::Uint16; Scale: `100`; Units: `bar`
    pub const START_PRESSURE: u8 = 1;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::Uint16; Scale: `100`; Units: `bar`
    pub const END_PRESSURE: u8 = 2;
    /// Value's type: `u32`; FitBaseType::UINT32; ProfileType::Uint32; Scale: `100`; Units: `L`
    pub const VOLUME_USED: u8 = 3;

    /// Create new TankSummary with all fields being set to its corresponding invalid value.
    pub const fn new() -> Self {
        Self {
            timestamp: typedef::DateTime(u32::MAX),
            sensor: typedef::AntChannelId(u32::MIN),
            start_pressure: u16::MAX,
            end_pressure: u16::MAX,
            volume_used: u32::MAX,
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }

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

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

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

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

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

    /// Set `volume_used` with scaled value, it will automatically be converted to its corresponding integer value.
    pub fn set_volume_used_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.volume_used = u32::MAX;
            return self;
        }
        self.volume_used = unscaled as u32;
        self
    }

    fn count_valid_fields(&self) -> usize {
        (self.timestamp.0 != u32::MAX) as usize
            + (self.sensor.0 != u32::MIN) as usize
            + (self.start_pressure != u16::MAX) as usize
            + (self.end_pressure != u16::MAX) as usize
            + (self.volume_used != u32::MAX) as usize
    }
}

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

impl From<&Message> for TankSummary {
    /// from creates new TankSummary struct based on given mesg.
    fn from(mesg: &Message) -> Self {
        const KNOWN_NUMS: [u64; 4] = [15, 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.sensor = typedef::AntChannelId(field.value.as_u32z()),
                1 => v.start_pressure = field.value.as_u16(),
                2 => v.end_pressure = field.value.as_u16(),
                3 => v.volume_used = field.value.as_u32(),
                _ => v.unknown_fields.push(field.clone()),
            };
        }

        v
    }
}

impl From<TankSummary> for Message {
    fn from(m: TankSummary) -> 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.sensor.0 != u32::MIN {
            fields.push(Field {
                num: 0,
                base_type: FitBaseType::UINT32Z,
                value: Value::Uint32(m.sensor.0),
                is_expanded: false,
            });
        };
        if m.start_pressure != u16::MAX {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.start_pressure),
                is_expanded: false,
            });
        };
        if m.end_pressure != u16::MAX {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::UINT16,
                value: Value::Uint16(m.end_pressure),
                is_expanded: false,
            });
        };
        if m.volume_used != u32::MAX {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::UINT32,
                value: Value::Uint32(m.volume_used),
                is_expanded: false,
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

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

#[cfg(feature = "serde")]
impl Serialize for TankSummary {
    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("TankSummary", n)?;
        if let Some(v) = self.timestamp.unix_timestamp() {
            state.serialize_field("timestamp", &v)?;
        }
        if self.sensor.0 != u32::MIN {
            state.serialize_field("sensor", &self.sensor)?;
        }
        if let Some(v) = self.start_pressure_scaled() {
            state.serialize_field("start_pressure", &v)?;
        }
        if let Some(v) = self.end_pressure_scaled() {
            state.serialize_field("end_pressure", &v)?;
        }
        if let Some(v) = self.volume_used_scaled() {
            state.serialize_field("volume_used", &v)?;
        }
        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>,
    sensor: typedef::AntChannelId,
    start_pressure: f64,
    end_pressure: f64,
    volume_used: f64,
    unknown_fields: Vec<Field>,
    developer_fields: Vec<DeveloperField>,
}

#[cfg(feature = "serde")]
impl From<De> for TankSummary {
    fn from(m: De) -> Self {
        Self {
            timestamp: m.timestamp.map_or_else(
                || typedef::DateTime(u32::MAX),
                typedef::DateTime::from_unix_timestamp,
            ),
            sensor: m.sensor,
            start_pressure: {
                let unscaled = (m.start_pressure + 0.0) * 100.0;
                if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u16::MAX as f64 {
                    u16::MAX
                } else {
                    unscaled as u16
                }
            },
            end_pressure: {
                let unscaled = (m.end_pressure + 0.0) * 100.0;
                if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u16::MAX as f64 {
                    u16::MAX
                } else {
                    unscaled as u16
                }
            },
            volume_used: {
                let unscaled = (m.volume_used + 0.0) * 100.0;
                if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u32::MAX as f64 {
                    u32::MAX
                } else {
                    unscaled as u32
                }
            },
            unknown_fields: m.unknown_fields,
            developer_fields: m.developer_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Default for De {
    fn default() -> Self {
        Self {
            timestamp: None,
            sensor: typedef::AntChannelId(u32::MIN),
            start_pressure: f64::from_bits(u64::MAX),
            end_pressure: f64::from_bits(u64::MAX),
            volume_used: f64::from_bits(u64::MAX),
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }
}