Struct std::fs::Metadata 1.0.0
[−]
[src]
pub struct Metadata(_);
Metadata information about a file.
This structure is returned from the metadata
function or method and
represents known metadata about a file such as its permissions, size,
modification times, etc.
Methods
impl Metadata
[src]
fn file_type(&self) -> FileType
1.1.0
Returns the file type for this metadata.
Examples
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); println!("{:?}", metadata.file_type()); Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); println!("{:?}", metadata.file_type());
fn is_dir(&self) -> bool
Returns whether this metadata is for a directory.
Examples
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.is_dir()); Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.is_dir());
fn is_file(&self) -> bool
Returns whether this metadata is for a regular file.
Examples
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(metadata.is_file()); Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(metadata.is_file());
fn len(&self) -> u64
Returns the size of the file, in bytes, this metadata is for.
Examples
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert_eq!(0, metadata.len()); Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert_eq!(0, metadata.len());
fn permissions(&self) -> Permissions
Returns the permissions of the file this metadata is for.
Examples
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.permissions().readonly()); Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); assert!(!metadata.permissions().readonly());
fn modified(&self) -> Result<SystemTime>
1.10.0
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
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.modified() { println!("{:?}", time); } else { println!("Not supported on this platform"); } Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.modified() { println!("{:?}", time); } else { println!("Not supported on this platform"); }
fn accessed(&self) -> Result<SystemTime>
1.10.0
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
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.accessed() { println!("{:?}", time); } else { println!("Not supported on this platform"); } Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.accessed() { println!("{:?}", time); } else { println!("Not supported on this platform"); }
fn created(&self) -> Result<SystemTime>
1.10.0
Returns the creation time listed in the 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
fn main() { fn foo() -> std::io::Result<()> { use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.created() { println!("{:?}", time); } else { println!("Not supported on this platform"); } Ok(()) } }use std::fs; let metadata = try!(fs::metadata("foo.txt")); if let Ok(time) = metadata.created() { println!("{:?}", time); } else { println!("Not supported on this platform"); }
Trait Implementations
impl Clone for Metadata
[src]
fn clone(&self) -> Metadata
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl MetadataExt for Metadata
1.1.0[src]
fn dev(&self) -> u64
fn ino(&self) -> u64
fn mode(&self) -> u32
fn nlink(&self) -> u64
fn uid(&self) -> u32
fn gid(&self) -> u32
fn rdev(&self) -> u64
fn size(&self) -> u64
fn atime(&self) -> i64
fn atime_nsec(&self) -> i64
fn mtime(&self) -> i64
fn mtime_nsec(&self) -> i64
fn ctime(&self) -> i64
fn ctime_nsec(&self) -> i64
fn blksize(&self) -> u64
fn blocks(&self) -> u64
impl MetadataExt for Metadata
1.1.0[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