Struct named_pipe::PipeOptions

pub struct PipeOptions { /* fields omitted */ }

Options and flags which can be used to configure how a pipe is created.

This builder exposes the ability to configure how a ConnectingServer is created.

Builder defaults:

• open_mode - Duplex
• in_buffer - 65536
• out_buffer - 65536
• first - true

Methods

impl PipeOptions

pub fn new<T: AsRef<OsStr>>(name: T) -> PipeOptions

pub fn first(&mut self, val: bool) -> &mut PipeOptions

Is this instance (or instances) will be first for this pipe name? Defaults to true.

pub fn open_mode(&mut self, val: OpenMode) -> &mut PipeOptions

Open mode for pipe instance. Defaults to Duplex.

pub fn in_buffer(&mut self, val: u32) -> &mut PipeOptions

Input buffer size for pipe instance. Defaults to 65536

pub fn out_buffer(&mut self, val: u32) -> &mut PipeOptions

Output buffer size for pipe instance. Defaults to 65536.

pub fn single(&self) -> Result<ConnectingServer>

Creates single instance of pipe with this options.

pub fn multiple(&self, num: u32) -> Result<Vec<ConnectingServer>>

Creates multiple instances of pipe with this options.

Trait Implementations

impl PartialEq<PipeOptions> for PipeOptions

fn eq(&self, other: &PipeOptions) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PipeOptions) -> bool

This method tests for !=.

impl Clone for PipeOptions

fn clone(&self) -> PipeOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PipeOptions

impl Debug for PipeOptions

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

Formats the value using the given formatter.

impl Hash for PipeOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].