Struct SBFile

pub struct SBFile {
    pub raw: SBFileRef,
}

Represents a file.

Fields

raw: SBFileRef

The underlying raw SBFileRef.

Implementations

impl SBFile

pub unsafe fn from_file( &self, file: *mut FILE, transfer_ownership: bool, ) -> SBFile

Create an SBFile from a libc::FILE.

Safety

The file pointer must be valid.

pub fn from_fd(&self, fd: i32, mode: &str, transfer_ownership: bool) -> SBFile

Create an SBFile from a file descriptor.

pub fn is_valid(&self) -> bool

Check whether or not this is a valid SBFile value.

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

Read data from the file.

If successful, the result will contain the number of bytes read.

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

Write data to the file.

If successful, the result will contain the number of bytes written.

pub fn flush(&self) -> Result<(), SBError>

Flush the file.

pub fn close(&self) -> Result<(), SBError>

Close the file.