Struct linux_object::fs::File

pub struct File { /* private fields */ }

file implement struct

Implementations

impl File

pub fn new(inode: Arc<dyn INode>, flags: OpenFlags, path: String) -> Arc<Self>

create a file struct

pub fn path(&self) -> &String

Returns the file path.

pub fn seek(&self, pos: SeekFrom) -> LxResult<u64>

seek from given type and offset

pub fn set_len(&self, len: u64) -> LxResult

resize the file

pub fn sync_all(&self) -> LxResult

Sync all data and metadata

pub fn sync_data(&self) -> LxResult

Sync data (not include metadata)

pub fn metadata(&self) -> LxResult<Metadata>

get metadata of file fstat

pub fn lookup_follow(
    &self,
    path: &str,
    max_follow: usize
) -> LxResult<Arc<dyn INode>>

lookup the file following the link

pub fn read_entry(&self) -> LxResult<String>

get the name of dir entry

pub fn inode(&self) -> Arc<dyn INode>

get INode of this file

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl FileLike for File

fn get_vmo(&self, offset: usize, len: usize) -> LxResult<Arc<VmObject>>

Returns the VmObject representing the file with given offset and len.

fn flags(&self) -> OpenFlags

Returns open flags.

fn set_flags(&self, f: OpenFlags) -> LxResult

Set open flags.

fn dup(&self) -> Arc<dyn FileLike>

Duplicate the file.

fn read<'life0, 'life1, 'async_trait>(
    &'life0 self,
    buf: &'life1 mut [u8]
) -> Pin<Box<dyn Future<Output = LxResult<usize>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

read to buffer

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

write from buffer

fn read_at<'life0, 'life1, 'async_trait>(
    &'life0 self,
    offset: u64,
    buf: &'life1 mut [u8]
) -> Pin<Box<dyn Future<Output = LxResult<usize>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

read to buffer at given offset

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

write from buffer at given offset

fn poll(&self, _events: PollEvents) -> LxResult<PollStatus>

wait for some event on a file descriptor

fn async_poll<'life0, 'async_trait>(
    &'life0 self,
    _events: PollEvents
) -> Pin<Box<dyn Future<Output = LxResult<PollStatus>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

wait for some event on a file descriptor use async

fn ioctl(
    &self,
    request: usize,
    arg1: usize,
    _arg2: usize,
    _arg3: usize
) -> LxResult<usize>

manipulates the underlying device parameters of special files

fn as_socket(&self) -> LxResult<&dyn Socket>

Casting between trait objects, or use crate: cast_trait_object

impl KernelObject for File

fn id(&self) -> KoID

Get object’s KoID.

fn type_name(&self) -> &str

Get the name of the type of the kernel object.

fn name(&self) -> String

Get object’s name.

fn set_name(&self, name: &str)

Set object’s name.

fn signal(&self) -> Signal

Get the signal status.

fn signal_set(&self, signal: Signal)

Assert signal.

fn signal_clear(&self, signal: Signal)

Deassert signal.

fn signal_change(&self, clear: Signal, set: Signal)

Change signal status: first clear then set indicated bits.

fn add_signal_callback(&self, callback: SignalHandler)

Add callback for signal status changes.

fn get_child(&self, _id: u64) -> Result<Arc<dyn KernelObject + 'static>, ZxError>

Attempt to find a child of the object with given KoID.

fn peer(&self) -> Result<Arc<dyn KernelObject + 'static>, ZxError>

Attempt to get the object’s peer.

fn related_koid(&self) -> u64

If the object is related to another (such as the other end of a channel, or the parent of a job), returns the KoID of that object, otherwise returns zero.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.