# Struct rustix::io::PipeFlags

source · [−]

    pub struct PipeFlags { /* private fields */ }

Expand description

`O_*` constants for use with `pipe_with`.

## Implementations

source

### impl PipeFlags

source

#### pub const CLOEXEC: Self = _

`O_CLOEXEC`

source

#### pub const DIRECT: Self = _

`O_DIRECT`

source

#### pub const NONBLOCK: Self = _

`O_NONBLOCK`

source

#### pub const fn empty() -> Self

Returns an empty set of flags.

source

#### pub const fn all() -> Self

Returns the set containing all flags.

source

#### pub const fn bits(&self) -> c_uint

Returns the raw value of the flags currently stored.

source

#### pub const fn from_bits(bits: c_uint) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

source

#### pub const fn from_bits_truncate(bits: c_uint) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

source

#### pub const unsafe fn from_bits_unchecked(bits: c_uint) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

##### Safety

The caller of the `bitflags!` macro can chose to allow or disallow extra bits for their bitflags type.

The caller of `from_bits_unchecked()` has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

source

#### pub const fn is_empty(&self) -> bool

Returns `true` if no flags are currently stored.

source

#### pub const fn is_all(&self) -> bool

Returns `true` if all flags are currently set.

source

#### pub const fn intersects(&self, other: Self) -> bool

Returns `true` if there are flags common to both `self` and `other`.

source

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

Returns `true` if all of the flags in `other` are contained within `self`.

source

#### pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

source

#### pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

source

#### pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

source

#### pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

source

#### pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in `self` and `other`.

Specifically, the returned set contains only the flags which are present in both `self` and `other`.

This is equivalent to using the `&` operator (e.g. `ops::BitAnd`), as in `flags & other`.

source

#### pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in `self` and `other`.

Specifically, the returned set contains all flags which are present in either `self` or `other`, including any which are present in both (see `Self::symmetric_difference` if that is undesirable).

This is equivalent to using the `|` operator (e.g. `ops::BitOr`), as in `flags | other`.

source

#### pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in `self` and `other`.

Specifically, the returned set contains all flags present in `self`, except for the ones present in `other`.

It is also conceptually equivalent to the “bit-clear” operation: `flags & !other` (and this syntax is also supported).

This is equivalent to using the `-` operator (e.g. `ops::Sub`), as in `flags - other`.

source

#### pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in `self` and `other`.

Specifically, the returned set contains the flags present which are present in `self` or `other`, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets `self` and `other`.

This is equivalent to using the `^` operator (e.g. `ops::BitXor`), as in `flags ^ other`.

source

#### pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in `self`, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between `Self::all()` and `self` (e.g. `Self::all() - self`)

This is equivalent to using the `!` operator (e.g. `ops::Not`), as in `!flags`.

## Trait Implementations

source

### impl Binary for PipeFlags

source

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

Formats the value using the given formatter.

source

### impl BitAnd<PipeFlags> for PipeFlags

source

#### fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

#### type Output = PipeFlags

The resulting type after applying the `&` operator.

source

### impl BitAndAssign<PipeFlags> for PipeFlags

source

#### fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source

### impl BitOr<PipeFlags> for PipeFlags

source

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

Returns the union of the two sets of flags.

#### type Output = PipeFlags

The resulting type after applying the `|` operator.

source

### impl BitOrAssign<PipeFlags> for PipeFlags

source

#### fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source

### impl BitXor<PipeFlags> for PipeFlags

source

#### fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

#### type Output = PipeFlags

The resulting type after applying the `^` operator.

source

### impl BitXorAssign<PipeFlags> for PipeFlags

source

#### fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source

### impl Clone for PipeFlags

source

#### fn clone(&self) -> PipeFlags

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from `source`. Read more

source

### impl Debug for PipeFlags

source

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

Formats the value using the given formatter. Read more

source

### impl Extend<PipeFlags> for PipeFlags

source

#### fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more

source

#### fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (`extend_one`)

Extends a collection with exactly one element.

source

#### fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (`extend_one`)

Reserves capacity in a collection for the given number of additional elements. Read more

source

### impl FromIterator<PipeFlags> for PipeFlags

source

#### fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more

source

### impl Hash for PipeFlags

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,

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

source

### impl LowerHex for PipeFlags

source

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

Formats the value using the given formatter.

source

### impl Not for PipeFlags

source

#### fn not(self) -> Self

Returns the complement of this set of flags.

#### type Output = PipeFlags

The resulting type after applying the `!` operator.

source

### impl Octal for PipeFlags

source

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

Formats the value using the given formatter.

source

### impl Ord for PipeFlags

source

#### fn cmp(&self, other: &PipeFlags) -> Ordering

This method returns an `Ordering` between `self` and `other`. Read more

1.21.0 · source

#### fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0 · source

#### fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0 · source

#### fn clamp(self, min: Self, max: Self) -> Self where
Self: PartialOrd<Self>,

Restrict a value to a certain interval. Read more

source

### impl PartialEq<PipeFlags> for PipeFlags

source

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

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

source

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

This method tests for `!=`.

source

### impl PartialOrd<PipeFlags> for PipeFlags

source

#### fn partial_cmp(&self, other: &PipeFlags) -> Option<Ordering>

This method returns an ordering between `self` and `other` values if one exists. Read more

1.0.0 · source

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

1.0.0 · source

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

source

### impl Sub<PipeFlags> for PipeFlags

source

#### fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

#### type Output = PipeFlags

The resulting type after applying the `-` operator.

source

### impl SubAssign<PipeFlags> for PipeFlags

source

#### fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source

### impl UpperHex for PipeFlags

source

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

Formats the value using the given formatter.

source

### impl Copy for PipeFlags

source

### impl Eq for PipeFlags

source

### impl StructuralEq for PipeFlags

source

### impl StructuralPartialEq for PipeFlags

## Auto Trait Implementations

### impl RefUnwindSafe for PipeFlags

### impl Send for PipeFlags

### impl Sync for PipeFlags

### impl Unpin for PipeFlags

### impl UnwindSafe for PipeFlags

## 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,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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,

#### 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>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.