Struct std::fs::Metadata 1.0.0[−][src]
pub struct 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.
Methods
impl Metadata[src]
impl Metadatapub fn file_type(&self) -> FileType1.1.0[src]
pub fn file_type(&self) -> FileTypeReturns 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]
pub fn is_dir(&self) -> boolReturns whether this metadata is for a directory. The
result is mutually exclusive to the result of
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]
pub fn is_file(&self) -> boolReturns whether this metadata is for a regular file. The
result is mutually exclusive to the result of
is_dir, and will be false for symlink metadata
obtained from symlink_metadata.
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]
pub fn len(&self) -> u64Returns 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]
pub fn permissions(&self) -> PermissionsReturns 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]
pub fn modified(&self) -> Result<SystemTime>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]
pub fn accessed(&self) -> Result<SystemTime>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]
pub fn created(&self) -> Result<SystemTime>Returns the creation time listed in this metadata.
The returned value corresponds to the birthtime field of stat on
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 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"); } Ok(()) }Run
Trait Implementations
impl Clone for Metadata[src]
impl Clone for Metadatafn clone(&self) -> Metadata[src]
fn clone(&self) -> MetadataReturns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)[src]
fn clone_from(&mut self, source: &Self)Performs copy-assignment from source. Read more
impl Debug for Metadata1.16.0[src]
impl Debug for Metadatafn fmt(&self, f: &mut Formatter) -> Result[src]
fn fmt(&self, f: &mut Formatter) -> ResultFormats the value using the given formatter. Read more
impl MetadataExt for Metadata1.1.0[src]
impl MetadataExt for Metadatafn as_raw_stat(&self) -> &stat[src]
fn as_raw_stat(&self) -> &stat: deprecated in favor of the accessor methods of this trait
Gain a reference to the underlying stat structure which contains the raw information returned by the OS. Read more
fn st_dev(&self) -> u64[src]
fn st_dev(&self) -> u64Returns the device ID on which this file resides. Read more
fn st_ino(&self) -> u64[src]
fn st_ino(&self) -> u64Returns the inode number. Read more
fn st_mode(&self) -> u32[src]
fn st_mode(&self) -> u32Returns the file type and mode. Read more
fn st_nlink(&self) -> u64[src]
fn st_nlink(&self) -> u64Returns the number of hard links to file. Read more
fn st_uid(&self) -> u32[src]
fn st_uid(&self) -> u32Returns the user ID of the file owner. Read more
fn st_gid(&self) -> u32[src]
fn st_gid(&self) -> u32Returns the group ID of the file owner. Read more
fn st_rdev(&self) -> u64[src]
fn st_rdev(&self) -> u64Returns the device ID that this file represents. Only relevant for special file. Read more
fn st_size(&self) -> u64[src]
fn st_size(&self) -> u64Returns the size of the file (if it is a regular file or a symbolic link) in bytes. Read more
fn st_atime(&self) -> i64[src]
fn st_atime(&self) -> i64Returns the last access time. Read more
fn st_atime_nsec(&self) -> i64[src]
fn st_atime_nsec(&self) -> i64Returns the last access time, nano seconds part. Read more
fn st_mtime(&self) -> i64[src]
fn st_mtime(&self) -> i64Returns the last modification time. Read more
fn st_mtime_nsec(&self) -> i64[src]
fn st_mtime_nsec(&self) -> i64Returns the last modification time, nano seconds part. Read more
fn st_ctime(&self) -> i64[src]
fn st_ctime(&self) -> i64Returns the last status change time. Read more
fn st_ctime_nsec(&self) -> i64[src]
fn st_ctime_nsec(&self) -> i64Returns the last status change time, nano seconds part. Read more
fn st_blksize(&self) -> u64[src]
fn st_blksize(&self) -> u64Returns the "preferred" blocksize for efficient filesystem I/O. Read more
fn st_blocks(&self) -> u64[src]
fn st_blocks(&self) -> u64Returns the number of blocks allocated to the file, 512-byte units. Read more
impl MetadataExt for Metadata1.1.0[src]
impl MetadataExt for Metadatafn dev(&self) -> u64[src]
fn dev(&self) -> u64Returns the ID of the device containing the file. Read more
fn ino(&self) -> u64[src]
fn ino(&self) -> u64Returns the inode number. Read more
fn mode(&self) -> u32[src]
fn mode(&self) -> u32Returns the rights applied to this file. Read more
fn nlink(&self) -> u64[src]
fn nlink(&self) -> u64Returns the number of hard links pointing to this file. Read more
fn uid(&self) -> u32[src]
fn uid(&self) -> u32Returns the user ID of the owner of this file. Read more
fn gid(&self) -> u32[src]
fn gid(&self) -> u32Returns the group ID of the owner of this file. Read more
fn rdev(&self) -> u64[src]
fn rdev(&self) -> u64Returns the device ID of this file (if it is a special one). Read more
fn size(&self) -> u64[src]
fn size(&self) -> u64Returns the total size of this file in bytes. Read more
fn atime(&self) -> i64[src]
fn atime(&self) -> i64Returns the time of the last access to the file. Read more
fn atime_nsec(&self) -> i64[src]
fn atime_nsec(&self) -> i64Returns the time of the last access to the file in nanoseconds. Read more
fn mtime(&self) -> i64[src]
fn mtime(&self) -> i64Returns the time of the last modification of the file. Read more
fn mtime_nsec(&self) -> i64[src]
fn mtime_nsec(&self) -> i64Returns the time of the last modification of the file in nanoseconds. Read more
fn ctime(&self) -> i64[src]
fn ctime(&self) -> i64Returns the time of the last status change of the file. Read more
fn ctime_nsec(&self) -> i64[src]
fn ctime_nsec(&self) -> i64Returns the time of the last status change of the file in nanoseconds. Read more
fn blksize(&self) -> u64[src]
fn blksize(&self) -> u64Returns the blocksize for filesystem I/O. Read more
fn blocks(&self) -> u64[src]
fn blocks(&self) -> u64Returns the number of blocks allocated to the file, in 512-byte units. Read more
impl MetadataExt for Metadata1.1.0[src]
impl MetadataExt for Metadatafn file_attributes(&self) -> u32[src]
fn file_attributes(&self) -> u32Returns the value of the dwFileAttributes field of this metadata. Read more
fn creation_time(&self) -> u64[src]
fn creation_time(&self) -> u64Returns the value of the ftCreationTime field of this metadata. Read more
fn last_access_time(&self) -> u64[src]
fn last_access_time(&self) -> u64Returns the value of the ftLastAccessTime field of this metadata. Read more
fn last_write_time(&self) -> u64[src]
fn last_write_time(&self) -> u64Returns the value of the ftLastWriteTime field of this metadata. Read more
fn file_size(&self) -> u64[src]
fn file_size(&self) -> u64Returns the value of the nFileSize{High,Low} fields of this metadata. Read more