1.0.0[−][src]Struct std::fs::Metadata
Metadata information about a file.
This structure is returned from the metadata or
symlink_metadata function or method and represents known
metadata about a file such as its permissions, size, modification
times, etc.
Implementations
impl Metadata[src]
pub fn file_type(&self) -> FileType1.1.0[src]
Returns the file type for this metadata.
Examples
fn main() -> std::io::Result<()> { use std::fs; let metadata = fs::metadata("foo.txt")?; println!("{:?}", metadata.file_type()); Ok(()) }Run
pub fn is_dir(&self) -> bool[src]
Returns true if this metadata is for a directory. The
result is mutually exclusive to the result of
Metadata::is_file, and will be false for symlink metadata
obtained from symlink_metadata.
Examples
fn main() -> std::io::Result<()> { use std::fs; let metadata = fs::metadata("foo.txt")?; assert!(!metadata.is_dir()); Ok(()) }Run
pub fn is_file(&self) -> bool[src]
Returns true if this metadata is for a regular file. The
result is mutually exclusive to the result of
Metadata::is_dir, and will be false for symlink metadata
obtained from symlink_metadata.
When the goal is simply to read from (or write to) the source, the most
reliable way to test the source can be read (or written to) is to open
it. Only using is_file can break workflows like diff <( prog_a ) on
a Unix-like system for example. See File::open or
OpenOptions::open for more information.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; assert!(metadata.is_file()); Ok(()) }Run
pub fn len(&self) -> u64[src]
Returns the size of the file, in bytes, this metadata is for.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; assert_eq!(0, metadata.len()); Ok(()) }Run
pub fn permissions(&self) -> Permissions[src]
Returns the permissions of the file this metadata is for.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; assert!(!metadata.permissions().readonly()); Ok(()) }Run
pub fn modified(&self) -> Result<SystemTime>1.10.0[src]
Returns the last modification time listed in this metadata.
The returned value corresponds to the mtime field of stat on Unix
platforms and the ftLastWriteTime field on Windows platforms.
Errors
This field may not be available on all platforms, and will return an
Err on platforms where it is not available.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; if let Ok(time) = metadata.modified() { println!("{:?}", time); } else { println!("Not supported on this platform"); } Ok(()) }Run
pub fn accessed(&self) -> Result<SystemTime>1.10.0[src]
Returns the last access time of this metadata.
The returned value corresponds to the atime field of stat on Unix
platforms and the ftLastAccessTime field on Windows platforms.
Note that not all platforms will keep this field update in a file's
metadata, for example Windows has an option to disable updating this
time when files are accessed and Linux similarly has noatime.
Errors
This field may not be available on all platforms, and will return an
Err on platforms where it is not available.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; if let Ok(time) = metadata.accessed() { println!("{:?}", time); } else { println!("Not supported on this platform"); } Ok(()) }Run
pub fn created(&self) -> Result<SystemTime>1.10.0[src]
Returns the creation time listed in this metadata.
The returned value corresponds to the btime field of statx on
Linux kernel starting from to 4.11, the birthtime field of stat on other
Unix platforms, and the ftCreationTime field on Windows platforms.
Errors
This field may not be available on all platforms, and will return an
Err on platforms or filesystems where it is not available.
Examples
use std::fs; fn main() -> std::io::Result<()> { let metadata = fs::metadata("foo.txt")?; if let Ok(time) = metadata.created() { println!("{:?}", time); } else { println!("Not supported on this platform or filesystem"); } Ok(()) }Run
Trait Implementations
impl Clone for Metadata[src]
impl Debug for Metadata1.16.0[src]
impl MetadataExt for Metadata1.1.0[src]
fn as_raw_stat(&self) -> &stat[src]
fn st_dev(&self) -> u64[src]
fn st_ino(&self) -> u64[src]
fn st_mode(&self) -> u32[src]
fn st_nlink(&self) -> u64[src]
fn st_uid(&self) -> u32[src]
fn st_gid(&self) -> u32[src]
fn st_rdev(&self) -> u64[src]
fn st_size(&self) -> u64[src]
fn st_atime(&self) -> i64[src]
fn st_atime_nsec(&self) -> i64[src]
fn st_mtime(&self) -> i64[src]
fn st_mtime_nsec(&self) -> i64[src]
fn st_ctime(&self) -> i64[src]
fn st_ctime_nsec(&self) -> i64[src]
fn st_birthtime(&self) -> i64[src]
fn st_birthtime_nsec(&self) -> i64[src]
fn st_blksize(&self) -> u64[src]
fn st_blocks(&self) -> u64[src]
fn st_gen(&self) -> u32[src]
fn st_flags(&self) -> u32[src]
impl MetadataExt for Metadata1.1.0[src]
fn as_raw_stat(&self) -> &stat[src]
fn st_dev(&self) -> u64[src]
fn st_ino(&self) -> u64[src]
fn st_mode(&self) -> u32[src]
fn st_nlink(&self) -> u64[src]
fn st_uid(&self) -> u32[src]
fn st_gid(&self) -> u32[src]
fn st_rdev(&self) -> u64[src]
fn st_size(&self) -> u64[src]
fn st_atime(&self) -> i64[src]
fn st_atime_nsec(&self) -> i64[src]
fn st_mtime(&self) -> i64[src]
fn st_mtime_nsec(&self) -> i64[src]
fn st_ctime(&self) -> i64[src]
fn st_ctime_nsec(&self) -> i64[src]
fn st_blksize(&self) -> u64[src]
fn st_blocks(&self) -> u64[src]
impl MetadataExt for Metadata1.1.0[src]
fn dev(&self) -> u64[src]
fn ino(&self) -> u64[src]
fn mode(&self) -> u32[src]
fn nlink(&self) -> u64[src]
fn uid(&self) -> u32[src]
fn gid(&self) -> u32[src]
fn rdev(&self) -> u64[src]
fn size(&self) -> u64[src]
fn atime(&self) -> i64[src]
fn atime_nsec(&self) -> i64[src]
fn mtime(&self) -> i64[src]
fn mtime_nsec(&self) -> i64[src]
fn ctime(&self) -> i64[src]
fn ctime_nsec(&self) -> i64[src]
fn blksize(&self) -> u64[src]
fn blocks(&self) -> u64[src]
impl MetadataExt for Metadata1.1.0[src]
fn file_attributes(&self) -> u32[src]
fn creation_time(&self) -> u64[src]
fn last_access_time(&self) -> u64[src]
fn last_write_time(&self) -> u64[src]
fn file_size(&self) -> u64[src]
fn volume_serial_number(&self) -> Option<u32>[src]
fn number_of_links(&self) -> Option<u32>[src]
fn file_index(&self) -> Option<u64>[src]
Auto Trait Implementations
impl RefUnwindSafe for Metadata
impl Send for Metadata
impl Sync for Metadata
impl Unpin for Metadata
impl UnwindSafe for Metadata
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow(&self) -> &TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W[src]
Notable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut Wimpl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W[src]
Notable traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut Wimpl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone, [src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T[src]
fn clone_into(&self, target: &mut T)[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,