Struct nt_native::File

pub struct File(_);

Methods

impl File

pub fn create_new(name: &NtString) -> Result<Self>

pub fn create_preallocated(name: &NtString, size: u64) -> Result<Self>

pub fn open(name: &NtString) -> Result<Self>

pub fn open_readonly(name: &NtString) -> Result<Self>

pub fn open_or_create(name: &NtString) -> Result<(Self, bool)>

pub fn owerwrite(name: &NtString) -> Result<Self>

pub fn owerwrite_or_create(name: &NtString) -> Result<(Self, bool)>

impl File

pub fn is_valid(&self) -> bool

pub fn close(&mut self) -> Result<()>

pub fn object_name(&self) -> Result<NtString>

impl File

pub fn pos(&self) -> Result<u64>

pub fn set_pos(&self, pos: u64) -> Result<u64>

pub fn size(&self) -> Result<u64>

pub fn size_on_disk(&self) -> Result<u64>

pub fn access_mask(&self) -> Result<Access>

pub fn alignment(&self) -> Result<usize>

Returns the buffer alignment required by the underlying device.

See FILE_ALIGNMENT_INFORMATION

pub fn mode(&self) -> Result<Options>

Returns the access mode of a file.
This flags are is only a subset of all possible Options flags!

See FILE_MODE_INFORMATION

pub fn is_remote(&self) -> Result<bool>

Returns whether the file system that contains the file is a remote file system.

See FILE_IS_REMOTE_DEVICE_INFORMATION

pub fn path_name(&self) -> Result<NtString>

Returns the pathname of a file or directory without a drive letter(volume). The volume can be mounted as a mountpoint, so using drive letters in low-level code is a very bad idea.

If the ObjectAttributes->RootDirectory handle was opened by file ID, path_name() returns the relative path. If only the relative path is returned, the file name string will not begin with a backslash.

See FILE_NAME_INFORMATION

pub fn set_end_of_file(&self, end_of_file: u64) -> Result<()>

Trait Implementations

impl AsRawHandle for File

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

impl Clone for File

fn clone(&self) -> File

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for File

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

Formats the value using the given formatter.

impl Flush for File

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

impl From<Handle> for File

fn from(handle: Handle) -> Self

Performs the conversion.

impl FromRawHandle for File

unsafe fn from_raw_handle(handle: RawHandle) -> Self

Constructs a new I/O object from the specified raw handle.

impl IntoRawHandle for File

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.

impl Read for File

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

impl Read for File

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl ReadAt for File

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

impl Seek for File

fn seek(&self, to: SeekFrom) -> Result<u64>

fn stream_position(&self) -> Result<u64>

fn stream_len(&self) -> Result<u64>

impl Seek for File

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

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

Returns the current seek position from the start of the stream.

impl Size for File

fn size(&self) -> Result<u64>

impl Write for File

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

impl Write for File

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

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

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

Flush 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 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, fmt: Arguments) -> Result<(), Error>

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

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

Creates a "by reference" adaptor for this instance of Write.

impl WriteAt for File

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