assembly 0.4.1

Library for files/resources for LU related software
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

//! Low-Level reader for FDB files
//!
//! This module provides a struct which can be used to access
//! a FDB file in any order the user desires.

use std::io::{BufRead, Read, Seek, SeekFrom};
use std::convert::TryFrom;

use crate::core::reader::{FileError, FileResult};
use super::file::*;
use super::parser;

use encoding::{Encoding, DecoderTrap};
use encoding::all::WINDOWS_1252;

/// Represents an FDB file via an encapsulated reader
pub struct DatabaseFile<'a, T> {
    inner: &'a mut T,
}

pub struct FDBRowHeaderAddrIterator<'it_ref, 'it_data, T> {
    next_addr: u32,
    file: &'it_ref mut DatabaseFile<'it_data, T>,
}

impl<'a,T> DatabaseFile<'a, T>
where T: Seek + BufRead {
    /// Open a file from a stream
    pub fn open<'b: 'a>(inner: &'b mut T) -> Self {
        DatabaseFile{inner}
    }

    /// Read a string from the file
    pub fn get_string(&mut self, addr: u32) -> FileResult<String> {
        let mut string: Vec<u8> = Vec::new();
        self.inner.seek(SeekFrom::Start(addr.into())).map_err(FileError::Seek)?;
        self.inner.read_until(0x00, &mut string).map_err(FileError::Read)?;
        if string.ends_with(&[0x00]) {
            string.pop();
        }
        WINDOWS_1252.decode(&string, DecoderTrap::Strict).map_err(FileError::from)
    }
}

impl<'a, T> DatabaseFile<'a, T>
where T: Seek + Read {
    /// Read the schema header
    pub fn get_header(&mut self) -> FileResult<FDBHeader> {
        let mut bytes: [u8; 8] = [0;8];
        self.inner.seek(SeekFrom::Start(0)).map_err(FileError::Seek)?;
        self.inner.read_exact(&mut bytes).map_err(FileError::Read)?;
        let (_rest, header) = parser::parse_header(&bytes[..]).map_err(FileError::from)?;
        Ok(header)
    }

    /// Read the table header
    pub fn get_table_header_list(&mut self, header: FDBHeader) -> FileResult<FDBTableHeaderList> {
        let mut table_headers_bytes: Vec<u8> = Vec::new();
        let byte_count: u64 = (header.table_count * 8).into();
        let list_addr: u64 = header.table_header_list_addr.into();
        let count = usize::try_from(header.table_count).map_err(FileError::Count)?;
        self.inner.seek(SeekFrom::Start(list_addr)).map_err(FileError::Seek)?;
        self.inner.take(byte_count).read_to_end(&mut table_headers_bytes).map_err(FileError::Read)?;
        let (_rest, table_header_list) = parser::parse_table_headers(&table_headers_bytes, count).map_err(FileError::from)?;
        Ok(table_header_list)
    }

    /// Read the table def header
    pub fn get_table_def_header(&mut self, addr: u32) -> FileResult<FDBTableDefHeader> {
        let mut table_def_header_bytes: [u8; 12] = [0; 12];

        self.inner.seek(SeekFrom::Start(addr.into())).map_err(FileError::Seek)?;
        self.inner.read_exact(&mut table_def_header_bytes).map_err(FileError::Read)?;
        let(_rest, def_header) = parser::parse_table_def_header(&table_def_header_bytes).map_err(FileError::from)?;
        Ok(def_header)
    }

    /// Get a 64bit integer
    pub fn get_i64(&mut self, addr: u32) -> FileResult<i64> {
        let mut bytes: [u8; 8] = [0; 8];
        self.inner.seek(SeekFrom::Start(addr.into())).map_err(FileError::Seek)?;
        self.inner.read_exact(&mut bytes).map_err(FileError::Read)?;
        Ok(i64::from_le_bytes(bytes))
    }

    /// Get the column header list
    pub fn get_column_header_list<'b>(&'b mut self, header: FDBTableDefHeader) -> FileResult<FDBColumnHeaderList> {
        let off: u64 = header.column_header_list_addr.into();
        let mut column_header_list_bytes: Vec<u8> = Vec::new();
        let byte_count = u64::from(header.column_count * 8);
        let count = usize::try_from(header.column_count).map_err(FileError::Count)?;
        self.inner.seek(SeekFrom::Start(off))
            .map_err(FileError::Seek)?;
        self.inner.take(byte_count).read_to_end(&mut column_header_list_bytes)
            .map_err(FileError::Read)?;
        let (_rest, column_header_list) = parser
            ::parse_column_header_list(&mut column_header_list_bytes, count)
            .map_err(FileError::from)?;
        Ok(column_header_list)
    }

    /// Get the table data header
    pub fn get_table_data_header(&mut self, addr: u32) -> FileResult<FDBTableDataHeader> {
        let off: u64 = addr.into();
        let mut table_data_header_bytes: [u8; 8] = [0; 8];
        self.inner.seek(SeekFrom::Start(off)).map_err(FileError::Seek)?;
        self.inner.read_exact(&mut table_data_header_bytes).map_err(FileError::Read)?;
        let (_rest, table_data_header) = parser
            ::parse_table_data_header(&table_data_header_bytes)
            .map_err(FileError::from)?;
        Ok(table_data_header)
    }

    /// Get the table bucket header list
    pub fn get_bucket_header_list(&mut self, header: FDBTableDataHeader) -> FileResult<FDBBucketHeaderList> {
        let off: u64 = header.bucket_header_list_addr.into();
        let count = usize::try_from(header.bucket_count).map_err(FileError::Count)?;
        let byte_count = u64::from(header.bucket_count * 4);
        let mut bucket_header_list_bytes: Vec<u8> = Vec::new();
        self.inner.seek(SeekFrom::Start(off)).map_err(FileError::Seek)?;
        self.inner.take(byte_count).read_to_end(&mut bucket_header_list_bytes)
            .map_err(FileError::Read)?;
        let (_rest, bucket_header_list) = parser
            ::parse_bucket_header_list(&bucket_header_list_bytes, count)
            .map_err(FileError::from)?;
        Ok(bucket_header_list)
    }

    /// Get a row header list entry
    pub fn get_row_header_list_entry(&mut self, addr: u32) -> FileResult<FDBRowHeaderListEntry> {
        let off = u64::from(addr);
        let mut row_header_list_entry_bytes: [u8; 8] = [0; 8];
        self.inner.seek(SeekFrom::Start(off))
            .map_err(FileError::Seek)?;
        self.inner.read_exact(&mut row_header_list_entry_bytes)
            .map_err(FileError::Read)?;
        let (_rest, row_header_list_entry) = parser
            ::parse_row_header_list_entry(&row_header_list_entry_bytes)
            .map_err(FileError::from)?;
        Ok(row_header_list_entry)
    }

    /// Get a row header
    pub fn get_row_header(&mut self, addr: u32) -> FileResult<FDBRowHeader> {
        let off = u64::from(addr);
        let mut row_header_bytes: [u8; 8] = [0; 8];
        self.inner.seek(SeekFrom::Start(off)).map_err(FileError::Seek)?;
        self.inner.read_exact(&mut row_header_bytes).map_err(FileError::Read)?;
        let (_rest, row_header) = parser
            ::parse_row_header(&row_header_bytes)
            .map_err(FileError::from)?;
        Ok(row_header)
    }

    pub fn get_field_data_list(&mut self, header: FDBRowHeader) -> FileResult<FDBFieldDataList> {
        let off: u64 = header.field_data_list_addr.into();
        let byte_count = u64::from(header.field_count * 8);
        let count = usize::try_from(header.field_count).map_err(FileError::Count)?;
        let mut field_data_list_bytes: Vec<u8> = Vec::with_capacity(count * 8);
        self.inner.seek(SeekFrom::Start(off)).map_err(FileError::Seek)?;
        self.inner.take(byte_count).read_to_end(&mut field_data_list_bytes)
            .map_err(FileError::Read)?;
        let (_rest, field_data_list) = parser
            ::parse_field_data_list(&field_data_list_bytes, count)
            .map_err(FileError::from)?;
        Ok(field_data_list)
    }
}

impl<'impl_data, T> DatabaseFile<'impl_data, T>
    where T: Seek + Read {

    // <'it_ref, 'it_data>

    // 'it_data > 'impl_data > 'it_ref > 'self
    pub fn get_row_header_addr_iterator<'p_self>(&'p_self mut self, addr: u32) -> FDBRowHeaderAddrIterator<'p_self, 'impl_data, T> {
        FDBRowHeaderAddrIterator::<'p_self, 'impl_data>{file: self, next_addr: addr}
    }
}

impl<'b: 'a, 'a, T> Iterator for FDBRowHeaderAddrIterator<'a, 'b, T>
where T: Read + Seek {
    type Item = FileResult<u32>;

    fn next(&mut self) -> Option<Self::Item> {
        match self.next_addr {
            std::u32::MAX => None,
            addr => match self.file.get_row_header_list_entry(addr) {
                Ok(entry) => {
                    self.next_addr = entry.row_header_list_next_addr;
                    Some(Ok(entry.row_header_addr))
                },
                Err(e) => {
                    self.next_addr = std::u32::MAX;
                    Some(Err(e))
                }
            },
        }
    }
}