gcode-nom 0.7.0

Visualization tool for inspecting a g-code file.
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

use nom::IResult;
use nom::Parser;
use nom::combinator::map;
use nom::number::streaming::le_u32;

use super::compression_type::CompressionType;
use super::compression_type::compression_parser;

/// Block header
///
/// The block header is the same for all blocks. It is defined as:
///
/// type                 size  description
/// Type                 u16   2 bytes Block type
/// Compression          u16   2 bytes Compression algorithm
/// Uncompressed size    u32   4 bytes Size of the data when uncompressed
/// Compressed size      u32   4 bytes Size of the data when compressed
///
/// The size in bytes of the block header is 8 when Compression = 0 and 12 in all other cases.
///
/// <https://github.com/prusa3d/libbgcode/blob/main/doc/specifications.md#block-header>
///
///
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct BlockHeader {
    // Compression algorithm
    pub(super) compression_type: CompressionType,
    // Size of data when uncompressed
    pub(super) uncompressed_size: u32,
    // Size of data when compressed
    pub(super) compressed_size: Option<u32>,
}

// In memory "Block Header" is a variable sized structure.
//
/// "The size in bytes of the block header is 8 when Compression = 0 and 12 in all other cases."
pub(super) fn block_header_parser(input: &[u8]) -> IResult<&[u8], BlockHeader> {
    let (remain, compression_type) = compression_parser(input)?;
    if compression_type == CompressionType::None {
        map(le_u32, |uncompressed_size| {
            // hh
            BlockHeader {
                compression_type: CompressionType::None,
                uncompressed_size,
                compressed_size: None,
            }
        })
        .parse(remain)
    } else {
        map((le_u32, le_u32), |(uncompressed_size, compressed_size)| {
            // hh
            BlockHeader {
                compression_type: compression_type.clone(),
                uncompressed_size,
                compressed_size: Some(compressed_size),
            }
        })
        .parse(remain)
    }
}

// Utils used for CRC checking.
impl BlockHeader {
    /// The size in bytes of the block header is 8 when Compression = 0 and 12 in all other cases.
    pub(super) const fn size_in_bytes(&self) -> usize {
        match self.compression_type {
            CompressionType::None => 8,
            _ => 12,
        }
    }

    pub(super) const fn payload_size_in_bytes(&self) -> usize {
        match self.compressed_size {
            Some(size) => size as usize,
            None => self.uncompressed_size as usize,
        }
    }
}