From 35ebf0340589a228750bc2e74915738ea401eb71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Harabie=C5=84?= Date: Wed, 17 Jul 2019 14:45:07 +0200 Subject: [PATCH] Fix false comment that crate does not support volume label in root dir --- src/fs.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/fs.rs b/src/fs.rs index 6e77e66..66b2b12 100644 --- a/src/fs.rs +++ b/src/fs.rs @@ -366,8 +366,8 @@ impl FileSystem { /// Returns a volume label from BPB in the Boot Sector as `String`. /// /// Non-ASCII characters are replaced by the replacement character (U+FFFD). - /// Note: File with `VOLUME_ID` attribute in root directory is ignored by this library. - /// Only label from BPB is used. + /// Note: This function returns label stored in the BPB structure. Use `read_volume_label_from_root_dir` to read + /// label from the root directory. #[cfg(feature = "alloc")] pub fn volume_label(&self) -> String { // Decode volume label from OEM codepage @@ -380,8 +380,8 @@ impl FileSystem { /// Returns a volume label from BPB in the Boot Sector as byte array slice. /// /// Label is encoded in the OEM codepage. - /// Note: File with `VOLUME_ID` attribute in root directory is ignored by this library. - /// Only label from BPB is used. + /// Note: This function returns label stored in the BPB structure. Use `read_volume_label_from_root_dir_as_bytes` + /// to read label from the root directory. pub fn volume_label_as_bytes(&self) -> &[u8] { const PADDING: u8 = 0x20; let full_label_slice = &self.bpb.volume_label;