⚠️ VeridianOS Kernel Documentation - This is low-level kernel code. All functions are unsafe unless explicitly marked otherwise. no_std

File

Struct File 

Source
pub struct File {
    pub node: Arc<dyn VfsNode>,
    pub flags: OpenFlags,
    pub nonblock: AtomicBool,
    pub position: RwLock<usize>,
    pub refcount: RwLock<usize>,
    pub path: Option<String>,
}
Expand description

Open file structure

Fields§

§node: Arc<dyn VfsNode>

VFS node this file refers to

§flags: OpenFlags

Open flags

§nonblock: AtomicBool

Non-blocking I/O flag (can be toggled via fcntl F_SETFL after open). Stored as AtomicBool because File is behind Arc and F_SETFL needs to toggle this without mutable access.

§position: RwLock<usize>

Current position in file

§refcount: RwLock<usize>

Reference count

§path: Option<String>

Absolute path this file was opened with (for dirfd resolution in *at syscalls)

Implementations§

Source§

impl File

Source

pub fn new(node: Arc<dyn VfsNode>, flags: OpenFlags) -> Self

Create a new file structure

Source

pub fn new_with_path( node: Arc<dyn VfsNode>, flags: OpenFlags, path: String, ) -> Self

Create a new file structure with a known path

Source

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

Read from the file

Source

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

Write to the file

Source

pub fn seek(&self, from: SeekFrom) -> Result<usize, KernelError>

Seek to a position in the file

Source

pub fn tell(&self) -> usize

Get current position

Source

pub fn inc_ref(&self)

Increment reference count

Source

pub fn dec_ref(&self) -> usize

Decrement reference count

Auto Trait Implementations§

§

impl !Freeze for File

§

impl !RefUnwindSafe for File

§

impl Send for File

§

impl Sync for File

§

impl Unpin for File

§

impl !UnwindSafe for File

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.