cdfs 0.2.3

Rust implementation of ISO 9660 / ECMA-119
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

// SPDX-License-Identifier: (MIT OR Apache-2.0)

mod extra_meta;
mod isodirectory;
mod isofile;
mod symlink;

pub use crate::parse::susp::{PosixAttributes, PosixFileMode, PosixTimestamp, SuspExtension};
pub use extra_meta::{ExtraAttributes, ExtraMeta};
pub use isodirectory::{ISODirectory, ISODirectoryIterator};
pub use isofile::{ISOFile, ISOFileReader};
pub use symlink::Symlink;

use crate::parse::directory_entry::{DirectoryEntryHeader, FileFlags};
use crate::{FileRef, ISO9660Reader, Result};

/// An entry inside of a directory on the filesystem.  Returned by the [`ISODirectoryIterator`] iterator.
///
/// # Notes
///
/// ISO 9660 / ECMA-119 define other common unix types such as sockets, pipes, and devices.
/// Currently only regular files, directories, and symbolic links are supported.
#[derive(Clone)]
pub enum DirectoryEntry<T: ISO9660Reader> {
    /// Directory entry.
    Directory(ISODirectory<T>),

    /// Regular file entry.
    File(ISOFile<T>),

    /// Symbolic link entry.
    Symlink(Symlink),
}

impl<T: ISO9660Reader> std::fmt::Debug for DirectoryEntry<T> {
    fn fmt(&self, fmt: &mut std::fmt::Formatter) -> std::fmt::Result {
        match self {
            Self::Directory(dir) => write!(fmt, "{dir:?}"),
            Self::File(file) => write!(fmt, "{file:?}"),
            Self::Symlink(link) => write!(fmt, "{link:?}"),
        }
    }
}

impl<T: ISO9660Reader> DirectoryEntry<T> {
    pub(crate) fn new(
        header: DirectoryEntryHeader,
        ext: ExtraMeta,
        identifier: String,
        file: FileRef<T>,
    ) -> Result<Self> {
        let is_dir = header.file_flags.contains(FileFlags::DIRECTORY);
        let is_symlink = match ext.attributes {
            Some(ref attributes) => attributes.mode.contains(PosixFileMode::TYPE_SYMLINK),
            None => false,
        };

        if is_dir {
            Ok(DirectoryEntry::Directory(ISODirectory::new(
                header, ext, identifier, file,
            )))
        } else if is_symlink {
            Ok(DirectoryEntry::Symlink(Symlink::new(
                header, ext, identifier,
            )?))
        } else {
            Ok(DirectoryEntry::File(ISOFile::new(
                header, ext, identifier, file,
            )?))
        }
    }

    /// Returns the name of the current `DirectoryEntry`.
    ///
    /// # Notes
    ///
    /// ISO-9660 / ECMA-119 specify various restrictions on what characters are allowed in an
    /// identifier, and how long they can be.  Joliet specifies UTF-16BE encoding for its
    /// alternative directory hierarchies.  Finally, in Rust [`String`]s use UTF-8.  The way this
    /// works in practice is that we're okay with identifiers that are UTF-8 or a subset thereof,
    /// unless a character encoding is explicitly specified (e.g. Joliet).  If UTF-16 is specified,
    /// it is assumed to be *big endian*.
    pub fn identifier(&self) -> &str {
        match *self {
            DirectoryEntry::Directory(ref dir) => &dir.identifier,
            DirectoryEntry::File(ref file) => &file.identifier,
            DirectoryEntry::Symlink(ref link) => &link.identifier,
        }
    }
}

impl<T: ISO9660Reader> ExtraAttributes for DirectoryEntry<T> {
    fn ext(&self) -> &ExtraMeta {
        match *self {
            DirectoryEntry::Directory(ref dir) => &dir.ext,
            DirectoryEntry::File(ref file) => &file.ext,
            DirectoryEntry::Symlink(ref link) => &link.ext,
        }
    }

    fn header(&self) -> &DirectoryEntryHeader {
        match *self {
            DirectoryEntry::Directory(ref dir) => &dir.header,
            DirectoryEntry::File(ref file) => &file.header,
            DirectoryEntry::Symlink(ref link) => &link.header,
        }
    }
}