hff-core 0.6.3

Hierarchical File Format: core structure
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

use super::{DepthFirstIter, TableIter};
use crate::{Chunk, Ecc, Header, IdType, Table, Version};
use std::{
    fmt::Debug,
    mem::size_of,
    ops::{Deref, DerefMut},
};

/// The Hff structure data.  This is an immutable representation of the
/// content of an Hff stream.
#[derive(Debug)]
pub struct Hff<T: Debug> {
    /// Was the structure in native endian?
    native: bool,
    /// The version of the file format.
    version: Version,
    /// The IdType of the hff.
    id_type: IdType,
    /// Content type of the hff.
    content_type: Ecc,
    /// The tables found in the header structure.
    tables: Vec<Table>,
    /// The chunks found within the header structure.
    chunks: Vec<Chunk>,
    /// Access system for the underlying stream.
    accessor: T,
}

impl<T: Debug> Hff<T> {
    /// Create a new Hff wrapper.
    pub fn new(
        accessor: T,
        header: Header,
        tables: impl Into<Vec<Table>>,
        chunks: impl Into<Vec<Chunk>>,
    ) -> Self {
        Self {
            native: header.is_native_endian(),
            version: header.version(),
            id_type: header.id_type(),
            content_type: header.content_type(),
            tables: tables.into(),
            chunks: chunks.into(),
            accessor,
        }
    }

    /// Return if the structure of the source was in native endian.
    pub fn is_native_endian(&self) -> bool {
        self.native
    }

    /// Return the version of the file structure the file was read from.
    pub fn version(&self) -> Version {
        self.version
    }

    /// The type of the ID's used in the hff file.
    pub fn id_type(&self) -> IdType {
        self.id_type
    }

    /// Get the content type of the container.
    pub fn content_type(&self) -> Ecc {
        self.content_type
    }

    /// Get the offset from the start of the file to the start of the chunk data.
    pub fn offset_to_data(&self) -> usize {
        size_of::<Header>()
            + (size_of::<Table>() * self.tables.len())
            + (size_of::<Chunk>() * self.chunks.len())
    }

    /// Get an iterator over the tables in depth first order.
    pub fn depth_first(&self) -> DepthFirstIter<'_, T> {
        DepthFirstIter::new(self)
    }

    /// Get an iterator over the child tables.
    pub fn tables(&self) -> TableIter<'_, T> {
        TableIter::new(self, 0)
    }

    /// Get access to the table array.
    pub fn tables_array(&self) -> &[Table] {
        &self.tables
    }

    /// Get access to the chunk array.
    pub fn chunks_array(&self) -> &[Chunk] {
        &self.chunks
    }
}

impl<T: Debug> Deref for Hff<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.accessor
    }
}

impl<T: Debug> DerefMut for Hff<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.accessor
    }
}