Struct OutputFile

pub struct OutputFile { /* private fields */ }

This implementation will yield output streams that block on writes, and output directly to a file. If truly async output is required, [AsyncStdoutStream] should be used instead.

Implementations

impl OutputFile

pub fn new(file: File) -> Self

Trait Implementations

impl AsyncWrite for OutputFile

fn poll_write( self: Pin<&mut Self>, _cx: &mut Context<'_>, buf: &[u8], ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<Result<()>>

Attempts to flush the object, ensuring that any buffered data reach their destination.

fn poll_shutdown( self: Pin<&mut Self>, _cx: &mut Context<'_>, ) -> Poll<Result<()>>

Initiates or attempts to shut down this writer, returning success when the I/O connection has completely shut down.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>], ) -> Poll<Result<usize, Error>>

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

fn is_write_vectored(&self) -> bool

Determines if this writer has an efficient poll_write_vectored implementation.

impl Clone for OutputFile

fn clone(&self) -> OutputFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl IsTerminal for OutputFile

fn is_terminal(&self) -> bool

Returns whether this stream is backed by a TTY.

impl OutputStream for OutputFile

fn write(&mut self, bytes: Bytes) -> StreamResult<()>

Write bytes after obtaining a permit to write those bytes

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

Trigger a flush of any bytes buffered in this stream implementation.

fn check_write(&mut self) -> StreamResult<usize>

Returns the number of bytes that are ready to be written to this stream.

fn blocking_write_and_flush<'life0, 'async_trait>( &'life0 mut self, bytes: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), StreamError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Send + 'async_trait,

Perform a write of up to 4096 bytes, and then flush the stream. Block until all of these operations are complete, or an error occurs.

fn write_zeroes(&mut self, nelem: usize) -> Result<(), StreamError>

Repeatedly write a byte to a stream. Important: this write must be non-blocking! Returning an Err which downcasts to a StreamError will be reported to Wasm as the empty error result. Otherwise, errors will trap.

fn blocking_write_zeroes_and_flush<'life0, 'async_trait>( &'life0 mut self, nelem: usize, ) -> Pin<Box<dyn Future<Output = Result<(), StreamError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Send + 'async_trait,

Perform a write of up to 4096 zeroes, and then flush the stream. Block until all of these operations are complete, or an error occurs.

fn write_ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<usize, StreamError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Send + 'async_trait,

Simultaneously waits for this stream to be writable and then returns how much may be written or the last error that happened.

fn cancel<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Send + 'async_trait,

Cancel any asynchronous work and wait for it to wrap up.

impl Pollable for OutputFile

fn ready<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

An asynchronous function which resolves when this object’s readiness operation is ready.

impl StdoutStream for OutputFile

fn p2_stream(&self) -> Box<dyn OutputStream>

Same as Self::async_stream except that a WASIp2 OutputStream is returned.

fn async_stream(&self) -> Box<dyn AsyncWrite + Send + Sync>

Returns a fresh new stream which can write to this output stream.