Struct XilaFileSystemFile 

pub struct XilaFileSystemFile { /* private fields */ }

Opaque shadow type generated for FFI pointer boundaries.

Implementations

impl XilaFileSystemFile

pub const fn from_real(real: &mut SynchronousFile) -> *mut Self

Converts a real allocated instance into an opaque raw pointer handle.

Note: This moves the real object onto the heap via Box to ensure its memory remains valid after this function returns.

pub unsafe fn into_real(ptr: *mut Self) -> *mut SynchronousFile

Consumes the opaque raw pointer handle and returns the original real type, reclaiming ownership and freeing the underlying heap allocation.

Safety

The pointer must be non-null and must have been created by from_real.

pub unsafe fn as_real<'a>(ptr: *const Self) -> &'a SynchronousFile

Temporarily borrows the real type immutably from the opaque pointer.

Safety

The pointer must be valid and dereferenceable for the duration of life ’a.

pub unsafe fn as_real_mut<'a>(ptr: *mut Self) -> &'a mut SynchronousFile

Temporarily borrows the real type mutably from the opaque pointer.

Safety

The pointer must be valid, dereferenceable, and unaliased for the duration of life ’a.

Methods from Deref<Target = SynchronousFile>

pub fn set_position(&mut self, position: &Position) -> Result<u64, Error>

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

pub fn write_vectored(&mut self, buffers: &[&[u8]]) -> Result<usize, Error>

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

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

pub fn read_until( &mut self, buffer: &mut [u8], delimiter: &[u8], ) -> Result<usize, Error>

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

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

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

pub fn get_statistics(&mut self) -> Result<Statistics, Error>

pub fn set_owner( &mut self, user: Option<UserIdentifier>, group: Option<GroupIdentifier>, ) -> Result<(), Error>

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

pub fn control<C>( &mut self, _command: C, argument: &<C as ControlCommand>::Input, ) -> Result<<C as ControlCommand>::Output, Error>

where C: ControlCommand, <C as ControlCommand>::Output: Default,

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

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

pub fn close_internal( &mut self, virtual_file_system: &VirtualFileSystem, ) -> Result<(), Error>

Trait Implementations

impl AsMut<SynchronousFile> for XilaFileSystemFile

fn as_mut(&mut self) -> &mut SynchronousFile

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<SynchronousFile> for XilaFileSystemFile

fn as_ref(&self) -> &SynchronousFile

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for XilaFileSystemFile

type Target = SynchronousFile

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for XilaFileSystemFile

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

Mutably dereferences the value.