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
|
// Copyright 2021 Colin Finck <colin@reactos.org>
// SPDX-License-Identifier: MIT OR Apache-2.0
use crate::attribute::NtfsAttributeType;
use crate::attribute_value::{NtfsAttributeValue, NtfsResidentAttributeValue};
use crate::error::{NtfsError, Result};
use crate::string::NtfsString;
use crate::structured_values::{
NtfsStructuredValue, NtfsStructuredValueFromResidentAttributeValue,
};
use arrayvec::ArrayVec;
use binread::io::{Cursor, Read, Seek};
use core::mem;
/// The smallest VolumeName attribute has a name containing just a single character.
const VOLUME_NAME_MIN_SIZE: usize = mem::size_of::<u16>();
/// The largest VolumeName attribute has a name containing 128 UTF-16 code points (256 bytes).
const VOLUME_NAME_MAX_SIZE: usize = 128 * mem::size_of::<u16>();
/// Structure of a $VOLUME_NAME attribute.
///
/// This attribute is only used by the top-level $Volume file and contains the user-defined name of this filesystem.
/// You can easily access it via [`Ntfs::volume_name`].
///
/// A $VOLUME_NAME attribute is always resident.
///
/// Reference: <https://flatcap.github.io/linux-ntfs/ntfs/attributes/volume_name.html>
///
/// [`Ntfs::volume_name`]: crate::Ntfs::volume_name
#[derive(Clone, Debug)]
pub struct NtfsVolumeName {
name: ArrayVec<u8, VOLUME_NAME_MAX_SIZE>,
}
impl NtfsVolumeName {
fn new<T>(r: &mut T, position: u64, value_length: u64) -> Result<Self>
where
T: Read + Seek,
{
if value_length < VOLUME_NAME_MIN_SIZE as u64 {
return Err(NtfsError::InvalidStructuredValueSize {
position,
ty: NtfsAttributeType::VolumeName,
expected: VOLUME_NAME_MIN_SIZE as u64,
actual: value_length,
});
} else if value_length > VOLUME_NAME_MAX_SIZE as u64 {
return Err(NtfsError::InvalidStructuredValueSize {
position,
ty: NtfsAttributeType::VolumeName,
expected: VOLUME_NAME_MAX_SIZE as u64,
actual: value_length,
});
}
let value_length = value_length as usize;
let mut name = ArrayVec::from([0u8; VOLUME_NAME_MAX_SIZE]);
r.read_exact(&mut name[..value_length])?;
name.truncate(value_length);
Ok(Self { name })
}
/// Gets the volume name and returns it wrapped in an [`NtfsString`].
pub fn name(&self) -> NtfsString {
NtfsString(&self.name)
}
/// Returns the volume name length, in bytes.
///
/// A volume name has a maximum length of 128 UTF-16 code points (256 bytes).
pub fn name_length(&self) -> usize {
self.name.len()
}
}
impl<'n, 'f> NtfsStructuredValue<'n, 'f> for NtfsVolumeName {
const TY: NtfsAttributeType = NtfsAttributeType::VolumeName;
fn from_attribute_value<T>(fs: &mut T, value: NtfsAttributeValue<'n, 'f>) -> Result<Self>
where
T: Read + Seek,
{
let position = value.data_position().unwrap();
let value_length = value.len();
let mut value_attached = value.attach(fs);
Self::new(&mut value_attached, position, value_length)
}
}
impl<'n, 'f> NtfsStructuredValueFromResidentAttributeValue<'n, 'f> for NtfsVolumeName {
fn from_resident_attribute_value(value: NtfsResidentAttributeValue<'f>) -> Result<Self> {
let position = value.data_position().unwrap();
let value_length = value.len();
let mut cursor = Cursor::new(value.data());
Self::new(&mut cursor, position, value_length)
}
}
|
