vibe.core.stream

Generic stream interface used by several stream-like classes.

This module defines the basic stream primitives. For concrete stream types, take a look at the vibe.stream package. The vibe.stream.operations module contains additional high-level operations on streams, such as reading streams by line or as a whole.

Members

Aliases

ConnectionStreamProxy
alias ConnectionStreamProxy = ConnectionStream
Undocumented in source.
InputStreamProxy
alias InputStreamProxy = InputStream
Undocumented in source.
OutputStreamProxy
alias OutputStreamProxy = OutputStream
Undocumented in source.
RandomAccessStreamProxy
alias RandomAccessStreamProxy = RandomAccessStream
Undocumented in source.
StreamProxy
alias StreamProxy = Stream
Undocumented in source.

Classes

NullOutputStream
class NullOutputStream

Stream implementation acting as a sink with no function.

Enums

IOMode
enum IOMode

Controls the waiting behavior of read/write operations.

isConnectionStream
eponymoustemplate isConnectionStream(T)
Undocumented in source.
isInputStream
eponymoustemplate isInputStream(T)
Undocumented in source.
isOutputStream
eponymoustemplate isOutputStream(T)
Undocumented in source.
isRandomAccessStream
eponymoustemplate isRandomAccessStream(T)
Undocumented in source.
isStream
eponymoustemplate isStream(T)
Undocumented in source.

Functions

nullSink
NullOutputStream nullSink()

Returns a NullOutputStream instance.

pipe
void pipe(IS source, OS sink, ulong nbytes)

Pipes an InputStream directly into this OutputStream.

Interfaces

ConnectionStream
interface ConnectionStream

Interface for streams based on a connection.

InputStream
interface InputStream

Interface for all classes implementing readable streams.

OutputStream
interface OutputStream

Interface for all classes implementing writeable streams.

RandomAccessStream
interface RandomAccessStream

Interface for all streams supporting random access.

Stream
interface Stream

Interface for all classes implementing readable and writable streams.

Mixin templates

validateConnectionStream
mixintemplate validateConnectionStream(T)
Undocumented in source.
validateInputStream
mixintemplate validateInputStream(T)
Undocumented in source.
validateOutputStream
mixintemplate validateOutputStream(T)
Undocumented in source.
validateRandomAccessStream
mixintemplate validateRandomAccessStream(T)
Undocumented in source.
validateStream
mixintemplate validateStream(T)
Undocumented in source.

Meta

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.

Authors

Sönke Ludwig