Skip to main content

multiboot2_header/
module_align.rs

1use crate::{HeaderTagFlag, HeaderTagHeader, HeaderTagType};
2use multiboot2_common::{MaybeDynSized, Tag};
3
4/// If this tag is present, provided boot modules must be page aligned.
5#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
6#[repr(C, align(8))]
7pub struct ModuleAlignHeaderTag {
8    header: HeaderTagHeader,
9}
10
11impl ModuleAlignHeaderTag {
12    /// Constructs a new tag.
13    #[must_use]
14    pub const fn new(flags: HeaderTagFlag) -> Self {
15        let header =
16            HeaderTagHeader::new(HeaderTagType::ModuleAlign, flags, size_of::<Self>() as u32);
17        Self { header }
18    }
19
20    /// Returns the [`HeaderTagType`].
21    #[must_use]
22    pub const fn typ(&self) -> HeaderTagType {
23        self.header.typ()
24    }
25
26    /// Returns the [`HeaderTagFlag`]s.
27    #[must_use]
28    pub const fn flags(&self) -> HeaderTagFlag {
29        self.header.flags()
30    }
31
32    /// Returns the size.
33    #[must_use]
34    pub const fn size(&self) -> u32 {
35        self.header.size()
36    }
37}
38
39impl MaybeDynSized for ModuleAlignHeaderTag {
40    type Header = HeaderTagHeader;
41
42    const BASE_SIZE: usize = size_of::<Self>();
43}
44
45impl Tag for ModuleAlignHeaderTag {
46    type IDType = HeaderTagType;
47    const ID: HeaderTagType = HeaderTagType::ModuleAlign;
48}
49
50#[cfg(test)]
51mod tests {
52    use crate::ModuleAlignHeaderTag;
53
54    #[test]
55    fn test_assert_size() {
56        assert_eq!(size_of::<ModuleAlignHeaderTag>(), 2 + 2 + 4);
57    }
58}