Struct miow::pipe::NamedPipeBuilder
[−]
[src]
pub struct NamedPipeBuilder { // some fields omitted }
A builder structure for creating a new named pipe.
Methods
impl NamedPipeBuilder
[src]
fn new<A: AsRef<OsStr>>(addr: A) -> NamedPipeBuilder
Creates a new named pipe builder with the default settings.
fn inbound(&mut self, allowed: bool) -> &mut Self
Indicates whether data is allowed to flow from the client to the server.
fn outbound(&mut self, allowed: bool) -> &mut Self
Indicates whether data is allowed to flow from the server to the client.
fn first(&mut self, first: bool) -> &mut Self
Indicates that this pipe must be the first instance.
If set to true, then creation will fail if there's already an instance elsewhere.
fn accept_remote(&mut self, accept: bool) -> &mut Self
Indicates whether this server can accept remote clients or not.
fn max_instances(&mut self, instances: u8) -> &mut Self
Specifies the maximum number of instances of the server pipe that are allowed.
The first instance of a pipe can specify this value. A value of 255 indicates that there is no limit to the number of instances.
fn out_buffer_size(&mut self, buffer: u32) -> &mut Self
Specifies the number of bytes to reserver for the output buffer
fn in_buffer_size(&mut self, buffer: u32) -> &mut Self
Specifies the number of bytes to reserver for the input buffer
fn create(&mut self) -> Result<NamedPipe>
Using the options in this builder, attempt to create a new named pipe.
This function will call the CreateNamedPipe
function and return the
result.