Module plumber_rs::pipe[][src]

The Plumber Pipe IO API wrapper

This module is the wrapper to the actual Plumber pipe API calls for Pipe IO

Structs

Pipe

The Rust wrapper of a Plumber pipe port.

PipeRef

A reference to a given pipe port.

Constants

PIPE_ASYNC

If this flag is set, it suggest Plumber framework use the async write thread if possible. This is typically useful when we want to write a large file

PIPE_DISABLED

The pipe is diable, which is only meaningful when the pipe is a fork of another pipe. It indicates do not forward data to this fork

PIPE_INPUT

Indicates the pipe port is an input side

PIPE_OUTPUT

Indictes the pipe port is an output side

PIPE_PERSIST

If this flag is set it suggest the Plumber framework to keep the communication resource for more event even after current resource has been processed

PIPE_SHADOW

This flag makes the output pipe a copy of input pipe. This is also called a fork, which split the dataflow into multiple ways.

Type Definitions

PipeDescriptor

The integer type used to represent a reference to the Pipe port

PipeFlags

The integer type for the Plumber pipe flags