Struct cap_async_std::fs::File [−][src]
A reference to an open file on a filesystem.
This corresponds to async_std::fs::File.
Note that this File has no open or create methods. To open or create
a file, you must first obtain a Dir containing the path, and then call
Dir::open or Dir::create.
Implementations
impl File[src]
pub unsafe fn from_std(std: File) -> Self[src]
Constructs a new instance of Self from the given async_std::fs::File.
Safety
async_std::fs::File is not sandboxed and may access any path that the host
process has access to.
pub fn into_std(self) -> File[src]
Consumes self and returns an async_std::fs::File.
pub async fn sync_all(&self) -> Result<()>[src]
Attempts to sync all OS-internal metadata to disk.
This corresponds to async_std::fs::File::sync_all.
pub async fn sync_data(&self) -> Result<()>[src]
This function is similar to sync_all, except that it may not synchronize
file metadata to a filesystem.
This corresponds to async_std::fs::File::sync_data.
pub async fn set_len(&self, size: u64) -> Result<()>[src]
Truncates or extends the underlying file, updating the size of this file to become size.
This corresponds to async_std::fs::File::set_len.
pub fn metadata(&self) -> Result<Metadata>[src]
Queries metadata about the underlying file.
This corresponds to async_std::fs::File::metadata.
pub async fn set_permissions(&self, perm: Permissions) -> Result<()>[src]
Changes the permissions on the underlying file.
This corresponds to async_std::fs::File::set_permissions.
Trait Implementations
impl AsRawFd for File[src]
impl AsyncRead for File[src]
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>
impl AsyncRead for &File[src]
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize>>
impl AsyncSeek for File[src]
impl AsyncSeek for &File[src]
impl AsyncWrite for File[src]
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>[src]
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>[src]
fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
impl AsyncWrite for &File[src]
fn poll_write(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &[u8]
) -> Poll<Result<usize>>
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>[src]
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>[src]
fn poll_write_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &[IoSlice<'_>]
) -> Poll<Result<usize>>
impl Debug for File[src]
impl FromRawFd for File[src]
unsafe fn from_raw_fd(fd: RawFd) -> Self[src]
impl IntoRawFd for File[src]
fn into_raw_fd(self) -> RawFd[src]
impl OwnsRaw for File[src]
Auto Trait Implementations
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, [src]
T: 'static + ?Sized,
impl<T> AsUnsafeFile for T where
T: OwnsRaw + AsRawFd, [src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_file(&self) -> UnsafeFile[src]
pub fn as_file_view(&self) -> View<'_, File>[src]
pub unsafe fn as_unscoped_file_view(&self) -> View<'static, File>[src]
pub fn eq_file<Filelike>(&self, other: &Filelike) -> bool where
Filelike: AsUnsafeFile, [src]
Filelike: AsUnsafeFile,
impl<T> AsUnsafeHandle for T where
T: OwnsRaw + AsRawFd, [src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_handle(&self) -> UnsafeHandle[src]
pub fn eq_handle<Handlelike>(&self, other: &Handlelike) -> bool where
Handlelike: AsUnsafeHandle, [src]
Handlelike: AsUnsafeHandle,
impl<T> AsUnsafeSocket for T where
T: OwnsRaw + AsRawFd, [src]
T: OwnsRaw + AsRawFd,
pub fn as_unsafe_socket(&self) -> UnsafeSocket[src]
pub fn as_tcp_stream_view(&self) -> View<'_, TcpStream>[src]
pub unsafe fn as_unscoped_tcp_stream_view(&self) -> View<'static, TcpStream>[src]
pub fn as_tcp_listener_view(&self) -> View<'_, TcpListener>[src]
pub unsafe fn as_unscoped_tcp_listener_view(&self) -> View<'static, TcpListener>[src]
pub fn as_udp_socket_view(&self) -> View<'_, UdpSocket>[src]
pub unsafe fn as_unscoped_udp_socket_view(&self) -> View<'static, UdpSocket>[src]
pub fn as_unix_stream_view(&self) -> View<'_, UnixStream>[src]
pub unsafe fn as_unscoped_unix_stream_view(&self) -> View<'static, UnixStream>[src]
pub fn eq_socket<Socketlike>(&self, other: &Socketlike) -> bool where
Socketlike: AsUnsafeSocket, [src]
Socketlike: AsUnsafeSocket,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized,
R: AsyncRead + ?Sized,
pub fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where
Self: Unpin,
Self: Unpin,
pub fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
pub fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin,
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin,
pub fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
pub fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where
Self: Unpin,
Self: Unpin,
pub fn take(self, limit: u64) -> Take<Self>
pub fn bytes(self) -> Bytes<Self>
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead,
R: AsyncRead,
pub fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + 'a + Send, Global>> where
Self: Send + 'a,
Self: Send + 'a,
impl<S> AsyncSeekExt for S where
S: AsyncSeek + ?Sized,
S: AsyncSeek + ?Sized,
impl<W> AsyncWriteExt for W where
W: AsyncWrite + ?Sized,
W: AsyncWrite + ?Sized,
pub fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self> where
Self: Unpin,
Self: Unpin,
pub fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
Self: Unpin,
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
Self: Unpin,
pub fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self> where
Self: Unpin,
Self: Unpin,
pub fn flush(&mut self) -> FlushFuture<'_, Self> where
Self: Unpin,
Self: Unpin,
pub fn close(&mut self) -> CloseFuture<'_, Self> where
Self: Unpin,
Self: Unpin,
pub fn boxed_writer<'a>(self) -> Pin<Box<dyn AsyncWrite + 'a + Send, Global>> where
Self: Send + 'a,
Self: Send + 'a,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> FromUnsafeFile for T where
T: OwnsRaw + FromRawFd, [src]
T: OwnsRaw + FromRawFd,
pub unsafe fn from_unsafe_file(unsafe_file: UnsafeFile) -> T[src]
pub fn from_filelike<Filelike>(filelike: Filelike) -> Self where
Filelike: IntoUnsafeFile, [src]
Filelike: IntoUnsafeFile,
impl<T> FromUnsafeSocket for T where
T: OwnsRaw + FromRawFd, [src]
T: OwnsRaw + FromRawFd,
pub unsafe fn from_unsafe_socket(unsafe_socket: UnsafeSocket) -> T[src]
pub fn from_socketlike<Socketlike>(socketlike: Socketlike) -> Self where
Socketlike: IntoUnsafeSocket, [src]
Socketlike: IntoUnsafeSocket,
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T> IntoUnsafeFile for T where
T: OwnsRaw + IntoRawFd, [src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_file(self) -> UnsafeFile[src]
impl<T> IntoUnsafeHandle for T where
T: OwnsRaw + IntoRawFd, [src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_handle(self) -> UnsafeHandle[src]
impl<T> IntoUnsafeSocket for T where
T: OwnsRaw + IntoRawFd, [src]
T: OwnsRaw + IntoRawFd,
pub fn into_unsafe_socket(self) -> UnsafeSocket[src]
impl<T> ReadExt for T where
T: AsyncRead + ?Sized, [src]
T: AsyncRead + ?Sized,
pub fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
pub fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin,
pub fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
pub fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn take(self, limit: u64) -> Take<Self>[src]
pub fn by_ref(&mut self) -> &mut Self[src]
pub fn bytes(self) -> Bytes<Self>[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead, [src]
R: AsyncRead,
impl<T> SeekExt for T where
T: AsyncSeek + ?Sized, [src]
T: AsyncSeek + ?Sized,
impl<T> SetTimes for T where
T: AsRawFd,
T: AsRawFd,
pub fn set_times(
&self,
atime: Option<SystemTimeSpec>,
mtime: Option<SystemTimeSpec>
) -> Result<(), Error>
&self,
atime: Option<SystemTimeSpec>,
mtime: Option<SystemTimeSpec>
) -> Result<(), Error>
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> WriteExt for T where
T: AsyncWrite + ?Sized, [src]
T: AsyncWrite + ?Sized,
pub fn write(&'a mut self, buf: &'a [u8]) -> WriteFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn flush(&mut self) -> FlushFuture<'_, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn write_vectored(
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
bufs: &'a [IoSlice<'a>]
) -> WriteVectoredFuture<'a, Self> where
Self: Unpin,
pub fn write_all(&'a mut self, buf: &'a [u8]) -> WriteAllFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn write_fmt(&'a mut self, fmt: Arguments<'_>) -> WriteFmtFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,