memfaultd 1.26.1

Memfault daemon for embedded Linux systems. Observability, logging, crash reporting, and updating all in one service. Learn more at https://docs.memfault.com/
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

//
// Copyright (c) Memfault, Inc.
// See License.txt for details
use eyre::{eyre, Result};
use strum_macros::EnumString;

#[derive(EnumString, Default, PartialEq, Eq, Debug)]
#[strum(serialize_all = "kebab-case")]
/// Supported export formats
pub enum ExportFormat {
    #[default]
    /// Default format is a MAR file (zip archive)
    Mar,
    /// Chunk is a memfault-specific format (it's a container on top of MAR).
    /// It's mostly useful when you are already exporting memfault chunks from a
    /// MCU device and want the Linux data in the same format.
    Chunk,
    /// Memfault chunks do not include a header to identify the format. They
    /// also do not include the length of the data. This format adds a 'CHNK'
    /// header and a length field.
    ChunkWrapped,
}

const CONTENT_TYPE_ZIP: &str = "application/zip";
const CONTENT_TYPE_CHUNK: &str = "application/vnd.memfault.chunk";
const CONTENT_TYPE_CHUNK_WRAPPED: &str = "application/vnd.memfault.chunk-wrapped";

impl ExportFormat {
    pub fn to_content_type(&self) -> &'static str {
        match self {
            ExportFormat::Mar => CONTENT_TYPE_ZIP,
            ExportFormat::Chunk => CONTENT_TYPE_CHUNK,
            ExportFormat::ChunkWrapped => CONTENT_TYPE_CHUNK_WRAPPED,
        }
    }

    fn from_mime_type(value: &str) -> Option<Self> {
        match value {
            "*/*" => Some(Self::Mar),
            CONTENT_TYPE_ZIP => Some(Self::Mar),
            CONTENT_TYPE_CHUNK => Some(Self::Chunk),
            CONTENT_TYPE_CHUNK_WRAPPED => Some(Self::ChunkWrapped),
            _ => None,
        }
    }

    pub fn from_accept_header(value: &str) -> Result<Self> {
        value
            .split(',')
            .find_map(|mime_type| {
                let mime_type = mime_type.trim();
                Self::from_mime_type(mime_type)
            })
            .ok_or_else(|| eyre!("Requested format not supported (Accept: {})", value))
    }
}

#[cfg(test)]
mod tests {
    use rstest::rstest;

    use super::*;

    #[rstest]
    #[case("*/*", ExportFormat::Mar)]
    #[case(CONTENT_TYPE_ZIP, ExportFormat::Mar)]
    #[case(format!("{}, {}", CONTENT_TYPE_ZIP, CONTENT_TYPE_CHUNK), ExportFormat::Mar)]
    #[case(format!("{}, {}", CONTENT_TYPE_CHUNK, CONTENT_TYPE_ZIP), ExportFormat::Chunk)]
    fn test_accept_header_parser<H: Into<String>>(
        #[case] header_value: H,
        #[case] expected_format: ExportFormat,
    ) {
        assert_eq!(
            ExportFormat::from_accept_header(&header_value.into()).unwrap(),
            expected_format
        );
    }
}