Struct UnnamedPipeCreationOptions 

#[non_exhaustive]
pub struct UnnamedPipeCreationOptions {
    pub inheritable: bool,
    pub security_descriptor: *mut c_void,
    pub buffer_size_hint: Option<NonZeroUsize>,
}

Available on Windows only.

Builder used to create unnamed pipes while supplying additional options.

You can use this instead of the simple pipe function to supply additional Windows-specific parameters to a pipe.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

inheritable: bool

Specifies whether the resulting pipe can be inherited by child processes.

The default value is true and you probably shouldn’t modify this, unless you want all child processes to explicitly be unable to use the pipe even if they attempt to use various fishy methods to find the handle in the parent process.

security_descriptor: *mut c_void

A pointer to the security descriptor for the pipe. Leave this at the default NULL unless you want something specific.

buffer_size_hint: Option<NonZeroUsize>

A hint on the buffer size for the pipe. There is no way to ensure or check that the system actually uses this exact size, since it’s only a hint. Set to None to disable the hint and rely entirely on the system’s default buffer size.

Implementations

impl UnnamedPipeCreationOptions

pub const fn new() -> Self

Starts with the default parameters for the pipe. Identical to Default::default().

pub fn inheritable(self, inheritable: bool) -> Self

Specifies whether the resulting pipe can be inherited by child processes.

See the associated field for more.

pub fn security_descriptor(self, security_descriptor: *mut c_void) -> Self

Specifies the pointer to the security descriptor for the pipe.

See the associated field for more.

pub fn buffer_size_hint(self, buffer_size_hint: Option<NonZeroUsize>) -> Self

Specifies the hint on the buffer size for the pipe.

See the associated field for more.

pub fn extract_security_attributes(self) -> SECURITY_ATTRIBUTES

Extracts the SECURITY_ATTRIBUTES from the builder. Primarily an implementation detail, but has other uses.

pub unsafe fn build(self) -> Result<(PubWriter, PubReader)>

Creates the pipe and returns its writing and reading ends, or the error if one occurred.

Safety

The security_descriptor field is passed directly to Win32 which is then dereferenced there, resulting in undefined behavior if it was an invalid non-null pointer. For the default configuration, this should never be a concern.

Trait Implementations

impl Clone for UnnamedPipeCreationOptions

fn clone(&self) -> UnnamedPipeCreationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnnamedPipeCreationOptions

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

Formats the value using the given formatter.

impl Default for UnnamedPipeCreationOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for UnnamedPipeCreationOptions

impl Send for UnnamedPipeCreationOptions

impl Sync for UnnamedPipeCreationOptions