nitro_fs 0.2.0

use byteorder::{LittleEndian, ReadBytesExt};

use std::io::{Cursor, Read};

use anyhow::{ensure, Result};

#[derive(Clone, Debug, thiserror::Error)]
#[error("FAT data has invalid size.")]
struct InvalidFatLen;

/// Represents an entry in the File Allocation Table.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct AllocInfo {
    /// The offset to the start of the file relative to the ROM start.
    pub start: u32,
    /// Length of the file.
    pub end: u32,
}

impl AllocInfo {
    pub fn new<R: Read>(reader: &mut R) -> Result<Self> {
        Ok(Self {
            start: reader.read_u32::<LittleEndian>()?,
            end: reader.read_u32::<LittleEndian>()?,
        })
    }

    pub fn len(&self) -> u32 {
        self.end - self.start
    }
}

/// Wrapper for handling File Allocation Table stuff
#[derive(Clone, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub struct FileAllocTable {
    list: Vec<AllocInfo>,
}

impl FileAllocTable {
    /// Takes a raw FAT and reads it into a list.
    /// 
    /// # Errors
    /// Will return an error if the length of the data is not
    /// divisible by 8. This is because each FAT entry is two
    /// 32-bit integers.
    /// 
    /// It will also return an error if reading from the data
    /// fails.
    pub fn new(fat: &[u8]) -> Result<Self> {
        // Each entry is 8 bytes, so if not divisible by 8
        // then there is an issue with the passed data.
        ensure!(fat.len() % 8 == 0, InvalidFatLen);

        let mut list = Vec::new();
        let mut cursor = Cursor::new(fat);
        let entries = fat.len() / 8;

        for _ in 0..entries {
            list.push(AllocInfo::new(&mut cursor)?);
        }

        Ok(Self {
            list
        })
    }

    /// Returns the allocation info for the given file ID.
    /// 
    /// If the given ID is not in the list, it will return `None`.
    pub fn get(&self, id: u16) -> Option<AllocInfo> {
        if self.list.len() >= id as usize {
            return Some(self.list[id as usize]);
        }

        None
    }
}