Struct File 

#[repr(C)]
pub struct File {
    pub ptr: Box<Arc<Mutex<File>>>,
    pub path: AzString,
    pub run_destructor: bool,
}

Thread-safe file handle with path tracking for the C API.

Fields

ptr: Box<Arc<Mutex<File>>>

path: AzString

run_destructor: bool

Implementations

impl File

pub fn open(path: &str) -> Option<Self>

Opens a file in read-only mode, returning None on failure.

pub fn create(path: &str) -> Option<Self>

Creates a file (truncating if it exists), returning None on failure.

pub fn read_to_string(&mut self) -> Option<AzString>

Reads the file at self.path into a string.

pub fn read_to_bytes(&mut self) -> Option<U8Vec>

Reads the file at self.path into a byte vector.

pub fn write_string(&mut self, string: &str) -> Option<()>

Writes a string to the file handle.

pub fn write_bytes(&mut self, bytes: &[u8]) -> Option<()>

Writes bytes to the file handle and syncs to disk.

pub fn close(self)

Closes the file by dropping the handle. Provided for C API symmetry.

Trait Implementations

impl Clone for File

fn clone(&self) -> Self

Returns a duplicate 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 Display for File

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

Formats the value using the given formatter.

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl PartialEq for File

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for File

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for File