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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
// 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};

/// Sleep Assessment message.
#[cfg_attr(feature = "serde", derive(Deserialize), serde(from = "De"))]
#[derive(Debug, Clone)]
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`; FitBaseType::UINT8; ProfileType::Uint8
    pub const COMBINED_AWAKE_SCORE: u8 = 0;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const AWAKE_TIME_SCORE: u8 = 1;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const AWAKENINGS_COUNT_SCORE: u8 = 2;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const DEEP_SLEEP_SCORE: u8 = 3;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const SLEEP_DURATION_SCORE: u8 = 4;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const LIGHT_SLEEP_SCORE: u8 = 5;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const OVERALL_SLEEP_SCORE: u8 = 6;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const SLEEP_QUALITY_SCORE: u8 = 7;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const SLEEP_RECOVERY_SCORE: u8 = 8;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const REM_SLEEP_SCORE: u8 = 9;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const SLEEP_RESTLESSNESS_SCORE: u8 = 10;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const AWAKENINGS_COUNT: u8 = 11;
    /// Value's type: `u8`; FitBaseType::UINT8; ProfileType::Uint8
    pub const INTERRUPTIONS_SCORE: u8 = 14;
    /// Value's type: `u16`; FitBaseType::UINT16; ProfileType::Uint16; 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 `None` when value is invalid.
    pub fn average_stress_during_sleep_scaled(&self) -> Option<f64> {
        if self.average_stress_during_sleep == u16::MAX {
            return None;
        }
        Some(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 Self {
        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,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.combined_awake_score),
                is_expanded: false,
            });
        };
        if m.awake_time_score != u8::MAX {
            fields.push(Field {
                num: 1,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.awake_time_score),
                is_expanded: false,
            });
        };
        if m.awakenings_count_score != u8::MAX {
            fields.push(Field {
                num: 2,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.awakenings_count_score),
                is_expanded: false,
            });
        };
        if m.deep_sleep_score != u8::MAX {
            fields.push(Field {
                num: 3,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.deep_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_duration_score != u8::MAX {
            fields.push(Field {
                num: 4,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.sleep_duration_score),
                is_expanded: false,
            });
        };
        if m.light_sleep_score != u8::MAX {
            fields.push(Field {
                num: 5,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.light_sleep_score),
                is_expanded: false,
            });
        };
        if m.overall_sleep_score != u8::MAX {
            fields.push(Field {
                num: 6,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.overall_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_quality_score != u8::MAX {
            fields.push(Field {
                num: 7,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.sleep_quality_score),
                is_expanded: false,
            });
        };
        if m.sleep_recovery_score != u8::MAX {
            fields.push(Field {
                num: 8,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.sleep_recovery_score),
                is_expanded: false,
            });
        };
        if m.rem_sleep_score != u8::MAX {
            fields.push(Field {
                num: 9,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.rem_sleep_score),
                is_expanded: false,
            });
        };
        if m.sleep_restlessness_score != u8::MAX {
            fields.push(Field {
                num: 10,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.sleep_restlessness_score),
                is_expanded: false,
            });
        };
        if m.awakenings_count != u8::MAX {
            fields.push(Field {
                num: 11,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.awakenings_count),
                is_expanded: false,
            });
        };
        if m.interruptions_score != u8::MAX {
            fields.push(Field {
                num: 14,
                base_type: FitBaseType::UINT8,
                value: Value::Uint8(m.interruptions_score),
                is_expanded: false,
            });
        };
        if m.average_stress_during_sleep != u16::MAX {
            fields.push(Field {
                num: 15,
                base_type: FitBaseType::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,
        }
    }
}

#[cfg(feature = "serde")]
impl Serialize for SleepAssessment {
    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("SleepAssessment", n)?;
        if self.combined_awake_score != u8::MAX {
            state.serialize_field("combined_awake_score", &self.combined_awake_score)?;
        }
        if self.awake_time_score != u8::MAX {
            state.serialize_field("awake_time_score", &self.awake_time_score)?;
        }
        if self.awakenings_count_score != u8::MAX {
            state.serialize_field("awakenings_count_score", &self.awakenings_count_score)?;
        }
        if self.deep_sleep_score != u8::MAX {
            state.serialize_field("deep_sleep_score", &self.deep_sleep_score)?;
        }
        if self.sleep_duration_score != u8::MAX {
            state.serialize_field("sleep_duration_score", &self.sleep_duration_score)?;
        }
        if self.light_sleep_score != u8::MAX {
            state.serialize_field("light_sleep_score", &self.light_sleep_score)?;
        }
        if self.overall_sleep_score != u8::MAX {
            state.serialize_field("overall_sleep_score", &self.overall_sleep_score)?;
        }
        if self.sleep_quality_score != u8::MAX {
            state.serialize_field("sleep_quality_score", &self.sleep_quality_score)?;
        }
        if self.sleep_recovery_score != u8::MAX {
            state.serialize_field("sleep_recovery_score", &self.sleep_recovery_score)?;
        }
        if self.rem_sleep_score != u8::MAX {
            state.serialize_field("rem_sleep_score", &self.rem_sleep_score)?;
        }
        if self.sleep_restlessness_score != u8::MAX {
            state.serialize_field("sleep_restlessness_score", &self.sleep_restlessness_score)?;
        }
        if self.awakenings_count != u8::MAX {
            state.serialize_field("awakenings_count", &self.awakenings_count)?;
        }
        if self.interruptions_score != u8::MAX {
            state.serialize_field("interruptions_score", &self.interruptions_score)?;
        }
        if let Some(v) = self.average_stress_during_sleep_scaled() {
            state.serialize_field("average_stress_during_sleep", &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 {
    combined_awake_score: u8,
    awake_time_score: u8,
    awakenings_count_score: u8,
    deep_sleep_score: u8,
    sleep_duration_score: u8,
    light_sleep_score: u8,
    overall_sleep_score: u8,
    sleep_quality_score: u8,
    sleep_recovery_score: u8,
    rem_sleep_score: u8,
    sleep_restlessness_score: u8,
    awakenings_count: u8,
    interruptions_score: u8,
    average_stress_during_sleep: f64,
    unknown_fields: Vec<Field>,
    developer_fields: Vec<DeveloperField>,
}

#[cfg(feature = "serde")]
impl From<De> for SleepAssessment {
    fn from(m: De) -> Self {
        Self {
            combined_awake_score: m.combined_awake_score,
            awake_time_score: m.awake_time_score,
            awakenings_count_score: m.awakenings_count_score,
            deep_sleep_score: m.deep_sleep_score,
            sleep_duration_score: m.sleep_duration_score,
            light_sleep_score: m.light_sleep_score,
            overall_sleep_score: m.overall_sleep_score,
            sleep_quality_score: m.sleep_quality_score,
            sleep_recovery_score: m.sleep_recovery_score,
            rem_sleep_score: m.rem_sleep_score,
            sleep_restlessness_score: m.sleep_restlessness_score,
            awakenings_count: m.awakenings_count,
            interruptions_score: m.interruptions_score,
            average_stress_during_sleep: {
                let unscaled = (m.average_stress_during_sleep + 0.0) * 100.0;
                if unscaled.is_nan() || unscaled.is_infinite() || unscaled > u16::MAX as f64 {
                    u16::MAX
                } else {
                    unscaled as u16
                }
            },
            unknown_fields: m.unknown_fields,
            developer_fields: m.developer_fields,
        }
    }
}

#[cfg(feature = "serde")]
impl Default for De {
    fn default() -> 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: f64::from_bits(u64::MAX),
            unknown_fields: Vec::new(),
            developer_fields: Vec::new(),
        }
    }
}