Skip to main content

HandleFlags

Struct HandleFlags 

Source
pub struct HandleFlags(/* private fields */);
Expand description

The flags a handle carries: whether a child process created with handle inheritance gets a copy of it, and whether closing it is refused.

A newtype over the Win32 bits, combined with |, because Windows defines the two the page documents and this crate does not narrow what the call reports: a bit it has never heard of is kept by from_bits and bits and is not an error.

§Example

use win_handles_sys::HandleFlags;

let both = HandleFlags::INHERIT | HandleFlags::PROTECT_FROM_CLOSE;
assert!(both.contains(HandleFlags::INHERIT));
assert!(both.contains(HandleFlags::PROTECT_FROM_CLOSE));
assert!(!HandleFlags::INHERIT.contains(HandleFlags::PROTECT_FROM_CLOSE));
assert_eq!(HandleFlags::default(), HandleFlags::NONE);

Implementations§

Source§

impl HandleFlags

Source

pub const NONE: Self

Neither flag: the handle is not inherited and may be closed.

Source

pub const INHERIT: Self

HANDLE_FLAG_INHERIT: a child process created with handle inheritance gets a copy of the handle.

Source

pub const PROTECT_FROM_CLOSE: Self

HANDLE_FLAG_PROTECT_FROM_CLOSE: closing the handle is refused.

Source

pub const fn from_bits(bits: u32) -> Self

The flags from their Win32 bits.

Source

pub const fn bits(self) -> u32

The flags’ Win32 bits.

Source

pub const fn contains(self, other: Self) -> bool

Whether every flag in other is in self.

Trait Implementations§

Source§

impl BitOr for HandleFlags

Source§

type Output = HandleFlags

The resulting type after applying the | operator.
Source§

fn bitor(self, other: Self) -> Self

Performs the | operation. Read more
Source§

impl Clone for HandleFlags

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for HandleFlags

Source§

impl Debug for HandleFlags

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HandleFlags

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for HandleFlags

Source§

impl Hash for HandleFlags

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for HandleFlags

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HandleFlags

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.