Struct ProtocolChannel 

pub struct ProtocolChannel { /* private fields */ }

The helper process’s write half of the request/response protocol.

A loaded VST3 plugin shares the helper’s file descriptors, and third-party plugins do print to stdout. Since the protocol is a line stream over the helper’s stdout, one stray printf would be read by the host as a response and desynchronise every later exchange.

ProtocolChannel::claim therefore takes stdout away from the plugin: on Unix it duplicates the inherited stdout onto a private, close-on-exec descriptor and repoints file descriptor 1 at stderr, so plugin output is merged into the helper’s stderr instead. Call it once, before any plugin code can run.

On non-Unix platforms the protocol still runs over the process stdout; a plugin writing there corrupts the stream (the host drops lines it cannot parse, which limits the damage to noise, but a well-formed line would still be taken for a response).

Implementations

impl ProtocolChannel

pub fn claim() -> Self

Claim the protocol channel for this process. See the type documentation.

Trait Implementations

impl Write for ProtocolChannel

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

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

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

Flushes 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, args: 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.