qcow 1.2.0

A library for working with QEMU qcow images
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

use crate::*;

mod feature_name;
pub use feature_name::*;

/// An extension to the header allowing additional data to be included.
#[derive_binread]
#[derive(Debug)]
pub enum HeaderExt {
    /// This header extension marks the end of the header extension area
    #[br(magic = 0_u32)]
    End,

    /// A table of names for features provided by incompatible/compatible features
    #[br(magic = 0x6803f857_u32)]
    FeatureNameTable (
        #[br(temp)]
        u32,

        #[br(align_after = 8, count = self_0 / 0x30)]
        Vec<FeatureName>,
    ),

    /// A string describing the name of the backing file format
    #[br(magic = 0xe2792aca_u32)]
    BackingFileFormat (
        #[br(temp)]
        u32,

        #[br(temp, count = self_0)]
        Vec<u8>,

        #[br(calc = {
            self_1.retain(|&x| x != 0);
            String::from_utf8_lossy(&self_1).into_owned()
        })]
        String,
    ),

    /// Path to external data file in the form of a string
    #[br(magic = 0x44415441_u32)]
    ExternalDataPath (
        #[br(temp)]
        u32,

        #[br(temp, count = self_0)]
        Vec<u8>,

        #[br(calc = {
            self_1.retain(|&x| x != 0);
            String::from_utf8_lossy(&self_1).into_owned()
        })]
        String,
    ),

    /// A feature for which this crate does not implement a parser for
    Unparsed {
        /// The type of the header extension
        kind: HeaderExtKind,

        #[br(temp)]
        data_len: u32,

        /// The data corresponding to this feature
        #[br(align_after = 8, count = data_len)]
        data: Vec<u8>
    },
}

impl HeaderExt {
    pub(crate) fn is_end(&self) -> bool {
        matches!(self, Self::End)
    }
}

/// The type of data provided by the given header extension
///
/// Header extension type:
///
/// * 0x00000000 - End of the header extension area
/// * 0xe2792aca - Backing file format name string
/// * 0x6803f857 - Feature name table
/// * 0x23852875 - Bitmaps extension
/// * 0x0537be77 - Full disk encryption header pointer
/// * 0x44415441 - External data file name string
/// * other      - Unknown header extension, can be safely ignored
#[derive_binread]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum HeaderExtKind {
    /// This header extension marks the end of the header extension area
    #[br(magic = 0_u32)]
    End,

    /// A table of names for features provided by incompatible/compatible features
    #[br(magic = 0x6803f857_u32)]
    FeatureNameTable,

    /// A string describing the name of the backing file format
    #[br(magic = 0xe2792aca_u32)]
    BackingFileFormat,

    /// Bitmaps extension
    #[br(magic = 0x23852875_u32)]
    BitmapsExtension,

    /// Extension is a pointer to the full disk encryption header
    #[br(magic = 0x0537be77_u32)]
    FullDiskEncryption,

    /// Path to external data file in the form of a string
    #[br(magic = 0x44415441_u32)]
    ExternalDataPath,

    /// A type of header extension unrecognized by this crate, possibly from the future!
    Other(u32),
}