Struct conserve::AtomicFile
[−]
[src]
pub struct AtomicFile { /* fields omitted */ }
Methods
impl AtomicFile
[src]
fn new(path: &Path) -> Result<AtomicFile>
[src]
fn close(self: AtomicFile, _report: &Report) -> Result<()>
[src]
Methods from Deref<Target = File>
fn sync_all(&self) -> Result<(), Error>
1.0.0[src]
Attempts to sync all OS-internal metadata to disk.
This function will attempt to ensure that all in-core data reaches the filesystem before returning.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = File::create("foo.txt")?; f.write_all(b"Hello, world!")?; f.sync_all()?;
fn sync_data(&self) -> Result<(), Error>
1.0.0[src]
This function is similar to sync_all
, except that it may not
synchronize file metadata to the filesystem.
This is intended for use cases that must synchronize content, but don't need the metadata on disk. The goal of this method is to reduce disk operations.
Note that some platforms may simply implement this in terms of
sync_all
.
Examples
use std::fs::File; use std::io::prelude::*; let mut f = File::create("foo.txt")?; f.write_all(b"Hello, world!")?; f.sync_data()?;
fn set_len(&self, size: u64) -> Result<(), Error>
1.0.0[src]
Truncates or extends the underlying file, updating the size of
this file to become size
.
If the size
is less than the current file's size, then the file will
be shrunk. If it is greater than the current file's size, then the file
will be extended to size
and have all of the intermediate data filled
in with 0s.
Errors
This function will return an error if the file is not opened for writing.
Examples
use std::fs::File; let mut f = File::create("foo.txt")?; f.set_len(10)?;
fn metadata(&self) -> Result<Metadata, Error>
1.0.0[src]
Queries metadata about the underlying file.
Examples
use std::fs::File; let mut f = File::open("foo.txt")?; let metadata = f.metadata()?;
fn try_clone(&self) -> Result<File, Error>
1.9.0[src]
Creates a new independently owned handle to the underlying file.
The returned File
is a reference to the same state that this object
references. Both handles will read and write with the same cursor
position.
Examples
use std::fs::File; let mut f = File::open("foo.txt")?; let file_copy = f.try_clone()?;
fn set_permissions(&self, perm: Permissions) -> Result<(), Error>
1.16.0[src]
Changes the permissions on the underlying file.
Platform-specific behavior
This function currently corresponds to the fchmod
function on Unix and
the SetFileInformationByHandle
function on Windows. Note that, this
may change in the future.
Errors
This function will return an error if the user lacks permission change attributes on the underlying file. It may also return an error in other os-specific unspecified cases.
Examples
use std::fs::File; let file = File::open("foo.txt")?; let mut perms = file.metadata()?.permissions(); perms.set_readonly(true); file.set_permissions(perms)?;
Trait Implementations
impl Write for AtomicFile
[src]
fn write(&mut self, buf: &[u8]) -> Result<usize>
[src]
Write a buffer into this object, returning how many bytes were written. Read more
fn flush(&mut self) -> Result<()>
[src]
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
1.0.0[src]
Attempts to write an entire buffer into this write. Read more
fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>
1.0.0[src]
Writes a formatted string into this writer, returning any error encountered. Read more
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
Creates a "by reference" adaptor for this instance of Write
. Read more
impl Deref for AtomicFile
[src]
type Target = File
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.