fluxfox 0.1.0

A library crate for working with floppy disk images for the IBM PC and compatibles.
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

/*
    FluxFox
    https://github.com/dbalsom/fluxfox

    Copyright 2024 Daniel Balsom

    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the “Software”),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.

    --------------------------------------------------------------------------

    src/containers/mod.rs

    A module supporting disk image container formats.
    Currently only ZIP is expected to be needed, but other container formats
    could be added in the future.

*/
use crate::{DiskCh, DiskImageFileFormat};
use std::{
    fmt::{Display, Formatter, Result},
    path::PathBuf,
};

#[cfg(feature = "zip")]
pub mod zip;

#[derive(Clone, Debug)]
pub struct KryoFluxSet {
    pub base_path: PathBuf,
    pub file_set:  Vec<PathBuf>,
    pub geometry:  DiskCh,
}

#[derive(Clone, Debug)]
pub enum DiskImageContainer {
    Raw(DiskImageFileFormat),
    Zip(DiskImageFileFormat),
    /// A set of Kryoflux images zipped together.
    /// The outer vector represents the number of disks in the archive (the number of unique
    /// paths found to a kryoflux .*00.0.raw file). It stores a tuple, the first element of which is
    /// the path to the raw files, the second is a Vec containing the full path of all raws in that
    /// set, and the third is the geometry of that set as DiskCh.
    ZippedKryofluxSet(Vec<KryoFluxSet>),
    KryofluxSet,
}

impl Display for DiskImageContainer {
    fn fmt(&self, f: &mut Formatter) -> Result {
        match self {
            DiskImageContainer::Raw(fmt) => write!(f, "{:?}", fmt),
            DiskImageContainer::Zip(fmt) => write!(f, "Zipped {:?}", fmt),
            DiskImageContainer::ZippedKryofluxSet(_) => write!(f, "Zipped Kryoflux Image Set"),
            DiskImageContainer::KryofluxSet => write!(f, "Kryoflux Image Set"),
        }
    }
}