Trait std::os::windows::fs::FileExt

1.15.0 · source · 
pub trait FileExt {
    // Required methods
    fn seek_read(&self, buf: &mut [u8], offset: u64) -> Result<usize>;
    fn seek_write(&self, buf: &[u8], offset: u64) -> Result<usize>;
}
Available on Windows only.
Expand description

Windows-specific extensions to fs::File.

Required Methods§

source

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

Seeks to a given position and reads a number of bytes.

Returns the number of bytes read.

The offset is relative to the start of the file and thus independent from the current cursor. The current cursor is affected by this function, it is set to the end of the read.

Reading beyond the end of the file will always return with a length of 0.

Note that similar to File::read, it is not an error to return with a short read. When returning from such a short read, the file pointer is still updated.

§Examples
use std::io;
use std::fs::File;
use std::os::windows::prelude::*;

fn main() -> io::Result<()> {
    let mut file = File::open("foo.txt")?;
    let mut buffer = [0; 10];

    // Read 10 bytes, starting 72 bytes from the
    // start of the file.
    file.seek_read(&mut buffer[..], 72)?;
    Ok(())
}
Run
source

fn seek_write(&self, buf: &[u8], offset: u64) -> Result<usize>

Seeks to a given position and writes a number of bytes.

Returns the number of bytes written.

The offset is relative to the start of the file and thus independent from the current cursor. The current cursor is affected by this function, it is set to the end of the write.

When writing beyond the end of the file, the file is appropriately extended and the intermediate bytes are left uninitialized.

Note that similar to File::write, it is not an error to return a short write. When returning from such a short write, the file pointer is still updated.

§Examples
use std::fs::File;
use std::os::windows::prelude::*;

fn main() -> std::io::Result<()> {
    let mut buffer = File::create("foo.txt")?;

    // Write a byte string starting 72 bytes from
    // the start of the file.
    buffer.seek_write(b"some bytes", 72)?;
    Ok(())
}
Run

Implementors§