rustyfit 0.8.1

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(unused, clippy::manual_range_patterns)]

use crate::profile::{ProfileType, typedef};
use crate::proto::*;
use alloc::vec::Vec;

#[derive(Debug, Clone)]
/// SleepAssessment is a SleepAssessment message.
pub struct SleepAssessment {
    /// Average of awake_time_score and awakenings_count_score. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub combined_awake_score: u8,
    /// Score that evaluates the total time spent awake between sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub awake_time_score: u8,
    /// Score that evaluates the number of awakenings that interrupt sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub awakenings_count_score: u8,
    /// Score that evaluates the amount of deep sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub deep_sleep_score: u8,
    /// Score that evaluates the quality of sleep based on sleep stages, heart-rate variability and possible awakenings during the night. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub sleep_duration_score: u8,
    /// Score that evaluates the amount of light sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub light_sleep_score: u8,
    /// Total score that summarizes the overall quality of sleep, combining sleep duration and quality. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub overall_sleep_score: u8,
    /// Score that evaluates the quality of sleep based on sleep stages, heart-rate variability and possible awakenings during the night. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub sleep_quality_score: u8,
    /// Score that evaluates stress and recovery during sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub sleep_recovery_score: u8,
    /// Score that evaluates the amount of REM sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub rem_sleep_score: u8,
    /// Score that evaluates the amount of restlessness during sleep. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub sleep_restlessness_score: u8,
    /// The number of awakenings during sleep.
    pub awakenings_count: u8,
    /// Score that evaluates the sleep interruptions. If valid: 0 (worst) to 100 (best). If unknown: FIT_UINT8_INVALID.
    pub interruptions_score: u8,
    /// Scale: 100; Excludes stress during awake periods in the sleep window
    pub average_stress_during_sleep: 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 SleepAssessment {
    /// Value's type: `u8`
    pub const COMBINED_AWAKE_SCORE: u8 = 0;
    /// Value's type: `u8`
    pub const AWAKE_TIME_SCORE: u8 = 1;
    /// Value's type: `u8`
    pub const AWAKENINGS_COUNT_SCORE: u8 = 2;
    /// Value's type: `u8`
    pub const DEEP_SLEEP_SCORE: u8 = 3;
    /// Value's type: `u8`
    pub const SLEEP_DURATION_SCORE: u8 = 4;
    /// Value's type: `u8`
    pub const LIGHT_SLEEP_SCORE: u8 = 5;
    /// Value's type: `u8`
    pub const OVERALL_SLEEP_SCORE: u8 = 6;
    /// Value's type: `u8`
    pub const SLEEP_QUALITY_SCORE: u8 = 7;
    /// Value's type: `u8`
    pub const SLEEP_RECOVERY_SCORE: u8 = 8;
    /// Value's type: `u8`
    pub const REM_SLEEP_SCORE: u8 = 9;
    /// Value's type: `u8`
    pub const SLEEP_RESTLESSNESS_SCORE: u8 = 10;
    /// Value's type: `u8`
    pub const AWAKENINGS_COUNT: u8 = 11;
    /// Value's type: `u8`
    pub const INTERRUPTIONS_SCORE: u8 = 14;
    /// Value's type: `u16`; Scale: `100`
    pub const AVERAGE_STRESS_DURING_SLEEP: u8 = 15;

    /// Create new SleepAssessment with all fields being set to its corresponding invalid value.
    pub const fn new() -> Self {
        Self {
            combined_awake_score: u8::MAX,
            awake_time_score: u8::MAX,
            awakenings_count_score: u8::MAX,
            deep_sleep_score: u8::MAX,
            sleep_duration_score: u8::MAX,
            light_sleep_score: u8::MAX,
            overall_sleep_score: u8::MAX,
            sleep_quality_score: u8::MAX,
            sleep_recovery_score: u8::MAX,
            rem_sleep_score: u8::MAX,
            sleep_restlessness_score: u8::MAX,
            awakenings_count: u8::MAX,
            interruptions_score: u8::MAX,
            average_stress_during_sleep: u16::MAX,
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }

    /// Returns `average_stress_during_sleep` in its scaled value. It returns invalid f64 when value is valid.
    pub fn average_stress_during_sleep_scaled(&self) -> f64 {
        if self.average_stress_during_sleep == u16::MAX {
            return f64::from_bits(u64::MAX);
        }
        self.average_stress_during_sleep as f64 / 100.0 - 0.0
    }

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

    fn count_valid_fields(&self) -> usize {
        (self.combined_awake_score != u8::MAX) as usize
            + (self.awake_time_score != u8::MAX) as usize
            + (self.awakenings_count_score != u8::MAX) as usize
            + (self.deep_sleep_score != u8::MAX) as usize
            + (self.sleep_duration_score != u8::MAX) as usize
            + (self.light_sleep_score != u8::MAX) as usize
            + (self.overall_sleep_score != u8::MAX) as usize
            + (self.sleep_quality_score != u8::MAX) as usize
            + (self.sleep_recovery_score != u8::MAX) as usize
            + (self.rem_sleep_score != u8::MAX) as usize
            + (self.sleep_restlessness_score != u8::MAX) as usize
            + (self.awakenings_count != u8::MAX) as usize
            + (self.interruptions_score != u8::MAX) as usize
            + (self.average_stress_during_sleep != u16::MAX) as usize
    }
}

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

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

        for field in &mesg.fields {
            match field.num {
                0 => v.combined_awake_score = field.value.as_u8(),
                1 => v.awake_time_score = field.value.as_u8(),
                2 => v.awakenings_count_score = field.value.as_u8(),
                3 => v.deep_sleep_score = field.value.as_u8(),
                4 => v.sleep_duration_score = field.value.as_u8(),
                5 => v.light_sleep_score = field.value.as_u8(),
                6 => v.overall_sleep_score = field.value.as_u8(),
                7 => v.sleep_quality_score = field.value.as_u8(),
                8 => v.sleep_recovery_score = field.value.as_u8(),
                9 => v.rem_sleep_score = field.value.as_u8(),
                10 => v.sleep_restlessness_score = field.value.as_u8(),
                11 => v.awakenings_count = field.value.as_u8(),
                14 => v.interruptions_score = field.value.as_u8(),
                15 => v.average_stress_during_sleep = field.value.as_u16(),
                _ => v.unknown_fields.push(field.clone()),
            };
        }

        v
    }
}

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

        if m.combined_awake_score != u8::MAX {
            fields.push(Field {
                num: 0,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.combined_awake_score),
                is_expanded: false,
            });
        };
        if m.awake_time_score != u8::MAX {
            fields.push(Field {
                num: 1,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.awake_time_score),
                is_expanded: false,
            });
        };
        if m.awakenings_count_score != u8::MAX {
            fields.push(Field {
                num: 2,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.awakenings_count_score),
                is_expanded: false,
            });
        };
        if m.deep_sleep_score != u8::MAX {
            fields.push(Field {
                num: 3,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.deep_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_duration_score != u8::MAX {
            fields.push(Field {
                num: 4,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.sleep_duration_score),
                is_expanded: false,
            });
        };
        if m.light_sleep_score != u8::MAX {
            fields.push(Field {
                num: 5,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.light_sleep_score),
                is_expanded: false,
            });
        };
        if m.overall_sleep_score != u8::MAX {
            fields.push(Field {
                num: 6,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.overall_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_quality_score != u8::MAX {
            fields.push(Field {
                num: 7,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.sleep_quality_score),
                is_expanded: false,
            });
        };
        if m.sleep_recovery_score != u8::MAX {
            fields.push(Field {
                num: 8,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.sleep_recovery_score),
                is_expanded: false,
            });
        };
        if m.rem_sleep_score != u8::MAX {
            fields.push(Field {
                num: 9,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.rem_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_restlessness_score != u8::MAX {
            fields.push(Field {
                num: 10,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.sleep_restlessness_score),
                is_expanded: false,
            });
        };
        if m.awakenings_count != u8::MAX {
            fields.push(Field {
                num: 11,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.awakenings_count),
                is_expanded: false,
            });
        };
        if m.interruptions_score != u8::MAX {
            fields.push(Field {
                num: 14,
                profile_type: ProfileType::UINT8,
                value: Value::Uint8(m.interruptions_score),
                is_expanded: false,
            });
        };
        if m.average_stress_during_sleep != u16::MAX {
            fields.push(Field {
                num: 15,
                profile_type: ProfileType::UINT16,
                value: Value::Uint16(m.average_stress_during_sleep),
                is_expanded: false,
            });
        };

        fields.extend_from_slice(&m.unknown_fields);

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