Struct File 

pub struct File<P: CheckedPermissions + MessageAllowed<CloseFile>> { /* private fields */ }

Implementations

impl<P: CheckedPermissions + MessageAllowed<CloseFile>> File<P>

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

where P: MessageAllowed<TruncateFile>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / TruncateFile

  Groups: file-system.mutate-delete

  Sender policy: signed

  Grant timing: location-grant

pub fn set_len(&mut self, len: u64) -> Result<(), Error>

where P: MessageAllowed<SetLen>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SetLen

  Groups: file-system.mutate-delete

  Sender policy: signed

  Grant timing: location-grant

pub fn metadata(&self) -> Result<Metadata, Error>

where P: MessageAllowed<GetMetadata>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / GetMetadata

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

pub fn set_mtime(&mut self, datetime: DateTime) -> Result<(), Error>

where P: MessageAllowed<SetMtime>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SetMtime

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

pub fn async_read(&mut self, read_len: usize) -> AsyncRead

Permission: os/fs / CloseFile

Groups: file-system.file-handles

Sender policy: signed

Grant timing: location-grant

Prepare a message that can be sent with slint_keyos_platform::async_archive Less efficient than a regular read() May return less bytes than requested. Returns an empty buffer on EOF

pub fn async_write(&mut self, buffer: Vec<u8>) -> AsyncWrite

Permission: os/fs / CloseFile

Groups: file-system.file-handles

Sender policy: signed

Grant timing: location-grant

Prepare a message that can be sent with slint_keyos_platform::async_archive Less efficient than a regular write() The actual bytes written is returned, may be less than the buffer size

pub fn async_copy_block_to( &mut self, to: &mut Self, len: usize, ) -> AsyncCopyBlock

Permission: os/fs / CloseFile

Groups: file-system.file-handles

Sender policy: signed

Grant timing: location-grant

Prepare a message that can be sent with slint_keyos_platform::async_scalar Efficiently copies between two open files. Returns the numebr of actually copied bytes. Returns Ok(0) on EOF

pub fn copy_block_to( &mut self, to: &mut Self, len: usize, ) -> Result<usize, Error>

where P: MessageAllowed<AsyncCopyBlock>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / AsyncCopyBlock

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

pub fn overwrite(&mut self, buf: &[u8]) -> Result<(), Error>

where P: MessageAllowed<SeekFile> + MessageAllowed<WriteFile> + MessageAllowed<TruncateFile> + MessageAllowed<Flush>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / TruncateFile

  Groups: file-system.mutate-delete

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / Flush

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

pub fn copy_to(&mut self, to: &mut Self) -> Result<(), Error>

where P: MessageAllowed<SeekFile> + MessageAllowed<WriteFile> + MessageAllowed<TruncateFile> + MessageAllowed<AsyncCopyBlock>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / TruncateFile

  Groups: file-system.mutate-delete

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / AsyncCopyBlock

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

Trait Implementations

impl<P: Debug + CheckedPermissions + MessageAllowed<CloseFile>> Debug for File<P>

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

Formats the value using the given formatter.

impl<P: CheckedPermissions + MessageAllowed<CloseFile>> Drop for File<P>

fn drop(&mut self)

Executes the destructor for this type.

impl<P> FileAdapter<P> for File<P>

where P: CheckedPermissions + MessageAllowed<CloseFile> + MessageAllowed<ReadFile> + MessageAllowed<WriteFile> + MessageAllowed<Flush> + MessageAllowed<SeekFile>,

fn metadata(&self) -> Result<Metadata, Error>

where P: MessageAllowed<GetMetadata>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / ReadFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / Flush

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / GetMetadata

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

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

where P: MessageAllowed<TruncateFile>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / ReadFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / Flush

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / TruncateFile

  Groups: file-system.mutate-delete

  Sender policy: signed

  Grant timing: location-grant

fn set_mtime(&mut self, datetime: DateTime) -> Result<(), Error>

where P: MessageAllowed<SetMtime>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / ReadFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / Flush

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SetMtime

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

fn copy_block_to(&mut self, to: &mut Self, len: usize) -> Result<usize, Error>

where P: MessageAllowed<AsyncCopyBlock>,

• Permission: os/fs / CloseFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / ReadFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / WriteFile

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / Flush

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / SeekFile

  Groups: file-system.file-handles

  Sender policy: signed

  Grant timing: location-grant

• Permission: os/fs / AsyncCopyBlock

  Groups: file-system.read-write

  Sender policy: signed

  Grant timing: location-grant

impl<P> Read for File<P>

where P: MessageAllowed<ReadFile> + CheckedPermissions + MessageAllowed<CloseFile>,

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

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

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<P> Seek for File<P>

where P: MessageAllowed<SeekFile> + CheckedPermissions + MessageAllowed<CloseFile>,

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

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

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<P> Write for File<P>

where P: MessageAllowed<WriteFile> + MessageAllowed<Flush> + CheckedPermissions + MessageAllowed<CloseFile>,

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.