hadris-udf 2.0.0

Pure Rust UDF filesystem library for optical media and disk images with no-std support
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

//! File Set Descriptor (ECMA-167 4/14.1)

use super::{CharSpec, DescriptorTag, EntityIdentifier, LongAllocationDescriptor, TagIdentifier};
use crate::error::Result;
use crate::time::UdfTimestamp;

/// File Set Descriptor (ECMA-167 4/14.1)
///
/// @hadris-spec ECMA-167:4/14.1
/// @hadris-compliance partial
/// @hadris-note The descriptor is modeled and tested, but clause-complete validation has not yet been established.
/// @hadris-tests write::tests::test_roundtrip_basic_verification
/// @hadris-fuzz udf_read
#[repr(C)]
#[derive(Debug, Clone, Copy)]
pub struct FileSetDescriptor {
    /// Descriptor tag
    pub tag: DescriptorTag,
    /// Recording Date and Time
    pub recording_date_time: UdfTimestamp,
    /// Interchange Level
    pub interchange_level: u16,
    /// Maximum Interchange Level
    pub max_interchange_level: u16,
    /// Character Set List
    pub character_set_list: u32,
    /// Maximum Character Set List
    pub max_character_set_list: u32,
    /// File Set Number
    pub file_set_number: u32,
    /// File Set Descriptor Number
    pub file_set_desc_number: u32,
    /// Logical Volume Identifier Character Set
    pub logical_volume_id_char_set: CharSpec,
    /// Logical Volume Identifier (dstring, 128 bytes)
    pub logical_volume_identifier: [u8; 128],
    /// File Set Character Set
    pub file_set_char_set: CharSpec,
    /// File Set Identifier (dstring, 32 bytes)
    pub file_set_identifier: [u8; 32],
    /// Copyright File Identifier (dstring, 32 bytes)
    pub copyright_file_identifier: [u8; 32],
    /// Abstract File Identifier (dstring, 32 bytes)
    pub abstract_file_identifier: [u8; 32],
    /// Root Directory ICB
    pub root_directory_icb: LongAllocationDescriptor,
    /// Domain Identifier
    pub domain_identifier: EntityIdentifier,
    /// Next Extent
    pub next_extent: LongAllocationDescriptor,
    /// System Stream Directory ICB
    pub system_stream_directory_icb: LongAllocationDescriptor,
    /// Reserved
    reserved: [u8; 32],
}

unsafe impl bytemuck::Zeroable for FileSetDescriptor {}
unsafe impl bytemuck::Pod for FileSetDescriptor {}

impl FileSetDescriptor {
    #[cfg(feature = "alloc")]
    pub(crate) fn into_native(mut self) -> Self {
        self.tag = DescriptorTag::from_disk_bytes(bytemuck::bytes_of(&self.tag))
            .expect("DescriptorTag has its fixed on-disk size");
        self.recording_date_time = self.recording_date_time.into_native();
        self.interchange_level = self.interchange_level.to_le();
        self.max_interchange_level = self.max_interchange_level.to_le();
        self.character_set_list = self.character_set_list.to_le();
        self.max_character_set_list = self.max_character_set_list.to_le();
        self.file_set_number = self.file_set_number.to_le();
        self.file_set_desc_number = self.file_set_desc_number.to_le();
        self.root_directory_icb = self.root_directory_icb.into_native();
        self.next_extent = self.next_extent.into_native();
        self.system_stream_directory_icb = self.system_stream_directory_icb.into_native();
        self
    }

    /// Validate this descriptor
    pub fn validate(&self, location: u32) -> Result<()> {
        self.tag
            .validate(TagIdentifier::FileSetDescriptor, location)
    }

    /// Get the root directory ICB location
    pub fn root_icb(&self) -> &LongAllocationDescriptor {
        &self.root_directory_icb
    }

    /// Get the file set identifier as a string
    #[cfg(feature = "alloc")]
    pub fn file_set_id(&self) -> alloc::string::String {
        super::primary::decode_dstring(&self.file_set_identifier)
    }

    /// Check if this is a UDF domain
    pub fn is_udf_domain(&self) -> bool {
        self.domain_identifier.is(b"*OSTA UDF Compliant")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    static_assertions::const_assert_eq!(size_of::<FileSetDescriptor>(), 512);
}