Struct file_locker::FileLock
source · [−]pub struct FileLock {
pub file: File,
}
Expand description
Represents the actually locked file
Fields
file: File
the std::fs::File
of the file that’s locked
Implementations
sourceimpl FileLock
impl FileLock
sourcepub fn new<T: AsRef<Path>>(file_path: T) -> FileLockBuilder<T>
pub fn new<T: AsRef<Path>>(file_path: T) -> FileLockBuilder<T>
Create a FileLockBuilder
blocking and writeable default to false
Examples
use file_locker::FileLock;
use std::io::prelude::*;
use std::io::Result;
fn main() -> Result<()> {
let mut filelock = FileLock::new("myfile.txt")
.writeable(true)
.blocking(true)
.lock()?;
filelock.file.write_all(b"Hello, world")?;
Ok(())
}
sourcepub fn lock(
file_path: impl AsRef<Path>,
blocking: bool,
writeable: bool
) -> Result<FileLock>
pub fn lock(
file_path: impl AsRef<Path>,
blocking: bool,
writeable: bool
) -> Result<FileLock>
Try to lock the specified file
Parameters
-
filename
is the path of the file we want to lock on -
is_blocking
is a flag to indicate if we should block if it’s already locked
If set, this call will block until the lock can be obtained.
If not set, this call will return immediately, giving an error if it would block
is_writable
is a flag to indicate if we want to lock for writing
Examples
use file_locker::FileLock;
use std::io::prelude::*;
use std::io::Result;
fn main() -> Result<()> {
let mut filelock = FileLock::lock("myfile.txt", false, false)?;
let mut buf = String::new();
filelock.file.read_to_string(&mut buf)?;
Ok(())
}
sourcepub fn unlock(&self) -> Result<()>
pub fn unlock(&self) -> Result<()>
Unlock our locked file
Note: This method is optional as the file lock will be unlocked automatically when dropped
Examples
use file_locker::FileLock;
use std::io::prelude::*;
use std::io::Result;
fn main() -> Result<()> {
let mut filelock = FileLock::new("myfile.txt")
.writeable(true)
.blocking(true)
.lock()?;
filelock.file.write_all(b"Hello, world")?;
filelock.unlock()?;
Ok(())
}
Trait Implementations
sourceimpl FileExt for FileLock
impl FileExt for FileLock
sourcefn read_at(&self, buf: &mut [u8], offset: u64) -> Result<usize>
fn read_at(&self, buf: &mut [u8], offset: u64) -> Result<usize>
Reads a number of bytes starting from a given offset. Read more
sourcefn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>
fn write_at(&self, buf: &[u8], offset: u64) -> Result<usize>
Writes a number of bytes starting from a given offset. Read more
sourceimpl Read for FileLock
impl Read for FileLock
sourcefn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
sourcefn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
Like read
, except that it reads into a slice of buffers. Read more
sourcefn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
1.0.0 · sourcefn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>
Read all bytes until EOF in this source, placing them into buf
. Read more
1.0.0 · sourcefn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
Read all bytes until EOF in this source, appending them to buf
. Read more
1.6.0 · sourcefn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
Read the exact number of bytes required to fill buf
. Read more
sourcefn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Pull some bytes from this source into the specified buffer. Read more
sourcefn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>
read_buf
)Read the exact number of bytes required to fill buf
. Read more
1.0.0 · sourcefn by_ref(&mut self) -> &mut Self
fn by_ref(&mut self) -> &mut Self
Creates a “by reference” adaptor for this instance of Read
. Read more
sourceimpl Seek for FileLock
impl Seek for FileLock
sourcefn seek(&mut self, pos: SeekFrom) -> Result<u64>
fn seek(&mut self, pos: SeekFrom) -> Result<u64>
Seek to an offset, in bytes, in a stream. Read more
1.55.0 · sourcefn rewind(&mut self) -> Result<(), Error>
fn rewind(&mut self) -> Result<(), Error>
Rewind to the beginning of a stream. Read more
sourceimpl Write for FileLock
impl Write for FileLock
sourcefn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Write a buffer into this writer, returning how many bytes were written. Read more
sourcefn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
sourcefn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>
fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>
sourcefn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)Determines if this Write
r has an efficient write_vectored
implementation. Read more
1.0.0 · sourcefn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Attempts to write an entire buffer into this writer. Read more
sourcefn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Attempts to write multiple buffers into this writer. Read more
Auto Trait Implementations
impl RefUnwindSafe for FileLock
impl Send for FileLock
impl Sync for FileLock
impl Unpin for FileLock
impl UnwindSafe for FileLock
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more