File

Struct File 

Source
pub struct File(/* private fields */);
Expand description

File structure.

This structure is used to represent a file in the virtual file system. This is a wrapper around the virtual file system file identifier.

Implementations§

Source§

impl File

Source

pub async fn open( virtual_file_system: &VirtualFileSystem, task: TaskIdentifier, path: impl AsRef<Path>, flags: Flags, ) -> Result<Self>

Source

pub async fn create_unnamed_pipe( file_system: &VirtualFileSystem, size: usize, status: StateFlags, ) -> Result<(Self, Self)>

Source

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

Source

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

Source

pub async fn read_slice_from_path( virtual_file_system: &VirtualFileSystem, task: TaskIdentifier, path: impl AsRef<Path>, buffer: &mut [u8], ) -> Result<()>

Source

pub async fn read_from_path( virtual_file_system: &VirtualFileSystem, task: TaskIdentifier, path: impl AsRef<Path>, buffer: &mut Vec<u8>, ) -> Result<()>

Source

pub async fn write_to_path( virtual_file_system: &VirtualFileSystem, task: TaskIdentifier, path: impl AsRef<Path>, buffer: &[u8], ) -> Result<()>

Source

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

Source

pub async fn display_content<W: Write>( &mut self, w: &mut W, buffer_size: usize, ) -> Result<()>

Source

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

Source

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

Source

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

Source

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

Source

pub async fn duplicate(&self) -> Result<Self>

Source

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

Source

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

Source

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

Source

pub async fn control<C>( &mut self, command: C, argument: &C::Input, ) -> Result<C::Output>

Source

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

Source

pub async fn close(self, virtual_file_system: &VirtualFileSystem) -> Result<()>

Source

pub fn into_synchronous_file(self) -> SynchronousFile

Trait Implementations§

Source§

impl Debug for File

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ErrorType for File

Source§

type Error = Error

Error type of all the IO operations on this type.
Source§

impl Write for File

Source§

async fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written. Read more
Source§

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.
Source§

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer. Read more
Source§

impl Write for File

Source§

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded. Read more
1.1.0 · Source§

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded. Read more
1.0.0 · Source§

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait. Read more

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§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.