Enum ehttpd::bytes::Sink

#[non_exhaustive]
pub enum Sink {
    Null,
    Vector(Vec<u8>),
    File(File),
    TcpStream(TcpStream),
    Other(Box<dyn AnySink + Send + UnwindSafe>),
}

A type-abstract data sink

Rationale

The idea behind this type is to provide some dynamic polymorphism, but with some “fast-paths” for common types to avoid the overhead of boxing and vtable-lookup (while the latter is probable negligible, the former may be significant overhead if all you want is to write to some preallocated memory).

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Null

A writer which will move data into the void

Vector(Vec<u8>)

A vector sink

File(File)

A file

TcpStream(TcpStream)

A TCP stream

Other(Box<dyn AnySink + Send + UnwindSafe>)

A catch-all/opaque variant for all types that cannot be covered by the enum’s specific variants

Implementations

impl Sink

pub fn from_other<T>(typed: T) -> Self

where T: AnySink + Send + UnwindSafe + 'static,

Creates a new catch-all/opaque variant from a typed object by moving it to the heap

Trait Implementations

impl Debug for Sink

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

Formats the value using the given formatter.

impl Default for Sink

fn default() -> Self

Returns the “default value” for a type.

impl From<File> for Sink

fn from(value: File) -> Self

Converts to this type from the input type.

impl From<TcpStream> for Sink

fn from(value: TcpStream) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Sink

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl Write for Sink

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

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

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

Flush 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, fmt: 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.