Struct BinFile 

pub struct BinFile<const MAGIC: u64, const VERSION: u16 = 1>(/* private fields */);

Binary file which ensures it always starts with a given magic byte octet.

Works as a drop-in replacement for File, which is checking that the file always start with an octet of some specific magic number and 16-bit version.

The magic byte octet is provided as a generic constant parameter in a form of 64-bit unsigned integer, which is serialized in big-endian order.

The version is provided as a generic constant parameter in a form of 16-bit unsigned integer, which is serialized in big-endian order.

It is recommended to start the version numbering from 1, and not zero.

Example

use binfile::BinFile;

const MY_MAGIC: u64 = u64::from_be_bytes(*b"MYMAGIC!");

BinFile::<MY_MAGIC, 1>::create("target/test").unwrap();

Implementations

impl<const MAGIC: u64, const VERSION: u16> BinFile<MAGIC, VERSION>

pub const MAGIC: u64 = MAGIC

The magical byte octet, taken from the generic parameter of the type. It must be a big endian-serialized octet.

pub const VERSION: u16 = VERSION

The version number, taken from the generic parameter of the type.

pub fn create(path: impl AsRef<Path>) -> Result<Self>

Opens the file in read-write mode, the same way as File::create does.

Creates the file if it doesn’t exist, and truncates if it does. In both cases, it writes the magic number and the version (10 bytes in total) at the start of the file. The produced file stream will start at byte offset 10.

pub fn create_new(path: impl AsRef<Path>) -> Result<Self>

Creates a new file in read-write mode; error if the file exists, the same way as File::create_new does.

Writes the magic number and the version (10 bytes in total) at the start of the file. The produced file stream will start at byte offset 10.

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Attempts to open a file in read-only mode the same way as File::open does.

Then it reads first 10 bytes of the file and verifies them to match the magic number (8 bytes) and version number (2 bytes). The produced file stream will start at byte offset 10.

pub fn open_rw(path: impl AsRef<Path>) -> Result<Self>

Attempts to open a file in read-write mode the same way as OpenOptions::new, followed by read(true) and write(true) calls does.

Then it reads first 10 bytes of the file and verifies them to match the magic number (8 bytes) and version number (2 bytes). The produced file stream will start at byte offset 10.

Methods from Deref<Target = File>

pub fn sync_all(&self) -> Result<(), Error>

Attempts to sync all OS-internal file content and metadata to disk.

This function will attempt to ensure that all in-memory data reaches the filesystem before returning.

This can be used to handle errors that would otherwise only be caught when the File is closed, as dropping a File will ignore all errors. Note, however, that sync_all is generally more expensive than closing a file by dropping it, because the latter is not required to block until the data has been written to the filesystem.

If synchronizing the metadata is not required, use sync_data instead.

Examples

use std::fs::File;
use std::io::prelude::*;

fn main() -> std::io::Result<()> {
    let mut f = File::create("foo.txt")?;
    f.write_all(b"Hello, world!")?;

    f.sync_all()?;
    Ok(())
}

pub fn sync_data(&self) -> Result<(), Error>

This function is similar to sync_all, except that it might 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::*;

fn main() -> std::io::Result<()> {
    let mut f = File::create("foo.txt")?;
    f.write_all(b"Hello, world!")?;

    f.sync_data()?;
    Ok(())
}

pub fn lock(&self) -> Result<(), Error>

Acquire an exclusive lock on the file. Blocks until the lock can be acquired.

This acquires an exclusive lock; no other file handle to this file may acquire another lock.

This lock may be advisory or mandatory. This lock is meant to interact with lock, try_lock, lock_shared, try_lock_shared, and unlock. Its interactions with other methods, such as read and write are platform specific, and it may or may not cause non-lockholders to block.

If this file handle/descriptor, or a clone of it, already holds a lock the exact behavior is unspecified and platform dependent, including the possibility that it will deadlock. However, if this method returns, then an exclusive lock is held.

If the file is not open for writing, it is unspecified whether this function returns an error.

The lock will be released when this file (along with any other file descriptors/handles duplicated or inherited from it) is closed, or if the unlock method is called.

Platform-specific behavior

This function currently corresponds to the flock function on Unix with the LOCK_EX flag, and the LockFileEx function on Windows with the LOCKFILE_EXCLUSIVE_LOCK flag. Note that, this may change in the future.

On Windows, locking a file will fail if the file is opened only for append. To lock a file, open it with one of .read(true), .read(true).append(true), or .write(true).

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let f = File::create("foo.txt")?;
    f.lock()?;
    Ok(())
}

pub fn lock_shared(&self) -> Result<(), Error>

Acquire a shared (non-exclusive) lock on the file. Blocks until the lock can be acquired.

This acquires a shared lock; more than one file handle may hold a shared lock, but none may hold an exclusive lock at the same time.

This lock may be advisory or mandatory. This lock is meant to interact with lock, try_lock, lock_shared, try_lock_shared, and unlock. Its interactions with other methods, such as read and write are platform specific, and it may or may not cause non-lockholders to block.

If this file handle/descriptor, or a clone of it, already holds a lock, the exact behavior is unspecified and platform dependent, including the possibility that it will deadlock. However, if this method returns, then a shared lock is held.

The lock will be released when this file (along with any other file descriptors/handles duplicated or inherited from it) is closed, or if the unlock method is called.

Platform-specific behavior

This function currently corresponds to the flock function on Unix with the LOCK_SH flag, and the LockFileEx function on Windows. Note that, this may change in the future.

On Windows, locking a file will fail if the file is opened only for append. To lock a file, open it with one of .read(true), .read(true).append(true), or .write(true).

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let f = File::open("foo.txt")?;
    f.lock_shared()?;
    Ok(())
}

pub fn try_lock(&self) -> Result<(), TryLockError>

Try to acquire an exclusive lock on the file.

Returns Err(TryLockError::WouldBlock) if a different lock is already held on this file (via another handle/descriptor).

This acquires an exclusive lock; no other file handle to this file may acquire another lock.

This lock may be advisory or mandatory. This lock is meant to interact with lock, try_lock, lock_shared, try_lock_shared, and unlock. Its interactions with other methods, such as read and write are platform specific, and it may or may not cause non-lockholders to block.

If this file handle/descriptor, or a clone of it, already holds a lock, the exact behavior is unspecified and platform dependent, including the possibility that it will deadlock. However, if this method returns Ok(()), then it has acquired an exclusive lock.

If the file is not open for writing, it is unspecified whether this function returns an error.

The lock will be released when this file (along with any other file descriptors/handles duplicated or inherited from it) is closed, or if the unlock method is called.

Platform-specific behavior

This function currently corresponds to the flock function on Unix with the LOCK_EX and LOCK_NB flags, and the LockFileEx function on Windows with the LOCKFILE_EXCLUSIVE_LOCK and LOCKFILE_FAIL_IMMEDIATELY flags. Note that, this may change in the future.

On Windows, locking a file will fail if the file is opened only for append. To lock a file, open it with one of .read(true), .read(true).append(true), or .write(true).

Examples

use std::fs::{File, TryLockError};

fn main() -> std::io::Result<()> {
    let f = File::create("foo.txt")?;
    // Explicit handling of the WouldBlock error
    match f.try_lock() {
        Ok(_) => (),
        Err(TryLockError::WouldBlock) => (), // Lock not acquired
        Err(TryLockError::Error(err)) => return Err(err),
    }
    // Alternately, propagate the error as an io::Error
    f.try_lock()?;
    Ok(())
}

pub fn try_lock_shared(&self) -> Result<(), TryLockError>

Try to acquire a shared (non-exclusive) lock on the file.

Returns Err(TryLockError::WouldBlock) if a different lock is already held on this file (via another handle/descriptor).

This acquires a shared lock; more than one file handle may hold a shared lock, but none may hold an exclusive lock at the same time.

This lock may be advisory or mandatory. This lock is meant to interact with lock, try_lock, lock_shared, try_lock_shared, and unlock. Its interactions with other methods, such as read and write are platform specific, and it may or may not cause non-lockholders to block.

If this file handle, or a clone of it, already holds a lock, the exact behavior is unspecified and platform dependent, including the possibility that it will deadlock. However, if this method returns Ok(()), then it has acquired a shared lock.

The lock will be released when this file (along with any other file descriptors/handles duplicated or inherited from it) is closed, or if the unlock method is called.

Platform-specific behavior

This function currently corresponds to the flock function on Unix with the LOCK_SH and LOCK_NB flags, and the LockFileEx function on Windows with the LOCKFILE_FAIL_IMMEDIATELY flag. Note that, this may change in the future.

On Windows, locking a file will fail if the file is opened only for append. To lock a file, open it with one of .read(true), .read(true).append(true), or .write(true).

Examples

use std::fs::{File, TryLockError};

fn main() -> std::io::Result<()> {
    let f = File::open("foo.txt")?;
    // Explicit handling of the WouldBlock error
    match f.try_lock_shared() {
        Ok(_) => (),
        Err(TryLockError::WouldBlock) => (), // Lock not acquired
        Err(TryLockError::Error(err)) => return Err(err),
    }
    // Alternately, propagate the error as an io::Error
    f.try_lock_shared()?;

    Ok(())
}

pub fn unlock(&self) -> Result<(), Error>

Release all locks on the file.

All locks are released when the file (along with any other file descriptors/handles duplicated or inherited from it) is closed. This method allows releasing locks without closing the file.

If no lock is currently held via this file descriptor/handle, this method may return an error, or may return successfully without taking any action.

Platform-specific behavior

This function currently corresponds to the flock function on Unix with the LOCK_UN flag, and the UnlockFile function on Windows. Note that, this may change in the future.

On Windows, locking a file will fail if the file is opened only for append. To lock a file, open it with one of .read(true), .read(true).append(true), or .write(true).

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let f = File::open("foo.txt")?;
    f.lock()?;
    f.unlock()?;
    Ok(())
}

pub fn set_len(&self, size: u64) -> Result<(), Error>

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.

The file’s cursor isn’t changed. In particular, if the cursor was at the end and the file is shrunk using this operation, the cursor will now be past the end.

Errors

This function will return an error if the file is not opened for writing. Also, std::io::ErrorKind::InvalidInput will be returned if the desired length would cause an overflow due to the implementation specifics.

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let mut f = File::create("foo.txt")?;
    f.set_len(10)?;
    Ok(())
}

Note that this method alters the content of the underlying file, even though it takes &self rather than &mut self.

pub fn metadata(&self) -> Result<Metadata, Error>

Queries metadata about the underlying file.

Examples

use std::fs::File;

fn main() -> std::io::Result<()> {
    let mut f = File::open("foo.txt")?;
    let metadata = f.metadata()?;
    Ok(())
}

pub fn try_clone(&self) -> Result<File, Error>

Creates a new File instance that shares the same underlying file handle as the existing File instance. Reads, writes, and seeks will affect both File instances simultaneously.

Examples

Creates two handles for a file named foo.txt:

use std::fs::File;

fn main() -> std::io::Result<()> {
    let mut file = File::open("foo.txt")?;
    let file_copy = file.try_clone()?;
    Ok(())
}

Assuming there’s a file named foo.txt with contents abcdef\n, create two handles, seek one of them, and read the remaining bytes from the other handle:

use std::fs::File;
use std::io::SeekFrom;
use std::io::prelude::*;

fn main() -> std::io::Result<()> {
    let mut file = File::open("foo.txt")?;
    let mut file_copy = file.try_clone()?;

    file.seek(SeekFrom::Start(3))?;

    let mut contents = vec![];
    file_copy.read_to_end(&mut contents)?;
    assert_eq!(contents, b"def\n");
    Ok(())
}

pub fn set_permissions(&self, perm: Permissions) -> Result<(), Error>

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

fn main() -> std::io::Result<()> {
    use std::fs::File;

    let file = File::open("foo.txt")?;
    let mut perms = file.metadata()?.permissions();
    perms.set_readonly(true);
    file.set_permissions(perms)?;
    Ok(())
}

Note that this method alters the permissions of the underlying file, even though it takes &self rather than &mut self.

pub fn set_times(&self, times: FileTimes) -> Result<(), Error>

Changes the timestamps of the underlying file.

Platform-specific behavior

This function currently corresponds to the futimens function on Unix (falling back to futimes on macOS before 10.13) and the SetFileTime function on Windows. Note that this may change in the future.

On most platforms, including UNIX and Windows platforms, this function can also change the timestamps of a directory. To get a File representing a directory in order to call set_times, open the directory with File::open without attempting to obtain write permission.

Errors

This function will return an error if the user lacks permission to change timestamps on the underlying file. It may also return an error in other os-specific unspecified cases.

This function may return an error if the operating system lacks support to change one or more of the timestamps set in the FileTimes structure.

Examples

fn main() -> std::io::Result<()> {
    use std::fs::{self, File, FileTimes};

    let src = fs::metadata("src")?;
    let dest = File::open("dest")?;
    let times = FileTimes::new()
        .set_accessed(src.accessed()?)
        .set_modified(src.modified()?);
    dest.set_times(times)?;
    Ok(())
}

pub fn set_modified(&self, time: SystemTime) -> Result<(), Error>

Changes the modification time of the underlying file.

This is an alias for set_times(FileTimes::new().set_modified(time)).

Trait Implementations

impl<const MAGIC: u64, const VERSION: u16> Debug for BinFile<MAGIC, VERSION>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<const MAGIC: u64, const VERSION: u16> Deref for BinFile<MAGIC, VERSION>

type Target = File

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const MAGIC: u64, const VERSION: u16> DerefMut for BinFile<MAGIC, VERSION>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const MAGIC: u64, const VERSION: u16> Read for BinFile<MAGIC, VERSION>

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.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<const MAGIC: u64, const VERSION: u16> Write for BinFile<MAGIC, VERSION>

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.