Struct gio::SubprocessFlags

pub struct SubprocessFlags { /* fields omitted */ }

Flags to define the behaviour of a Subprocess.

Note that the default for stdin is to redirect from /dev/null. For stdout and stderr the default are for them to inherit the corresponding descriptor from the calling process.

Note that it is a programmer error to mix ‘incompatible’ flags. For example, you may not request both STDOUT_PIPE and STDOUT_SILENCE.

Implementations

impl SubprocessFlags

pub const NONE: SubprocessFlags

No flags.

pub const STDIN_PIPE: SubprocessFlags

create a pipe for the stdin of the spawned process that can be accessed with Subprocess::stdin_pipe().

pub const STDIN_INHERIT: SubprocessFlags

stdin is inherited from the calling process.

pub const STDOUT_PIPE: SubprocessFlags

create a pipe for the stdout of the spawned process that can be accessed with Subprocess::stdout_pipe().

pub const STDOUT_SILENCE: SubprocessFlags

silence the stdout of the spawned process (ie: redirect to /dev/null).

pub const STDERR_PIPE: SubprocessFlags

create a pipe for the stderr of the spawned process that can be accessed with Subprocess::stderr_pipe().

pub const STDERR_SILENCE: SubprocessFlags

silence the stderr of the spawned process (ie: redirect to /dev/null).

pub const STDERR_MERGE: SubprocessFlags

merge the stderr of the spawned process with whatever the stdout happens to be. This is a good way of directing both streams to a common log file, for example.

pub const INHERIT_FDS: SubprocessFlags

spawned processes will inherit the file descriptors of their parent, unless those descriptors have been explicitly marked as close-on-exec. This flag has no effect over the “standard” file descriptors (stdin, stdout, stderr).

pub const fn empty() -> SubprocessFlags

Returns an empty set of flags

pub const fn all() -> SubprocessFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<SubprocessFlags>

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

pub const fn from_bits_truncate(bits: u32) -> SubprocessFlags

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> SubprocessFlags

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

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

pub fn insert(&mut self, other: SubprocessFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SubprocessFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SubprocessFlags)

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for SubprocessFlags

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

Formats the value using the given formatter.

impl BitAnd<SubprocessFlags> for SubprocessFlags

fn bitand(self, other: SubprocessFlags) -> SubprocessFlags

Returns the intersection between the two sets of flags.

type Output = SubprocessFlags

The resulting type after applying the & operator.

impl BitAndAssign<SubprocessFlags> for SubprocessFlags

fn bitand_assign(&mut self, other: SubprocessFlags)

Disables all flags disabled in the set.

impl BitOr<SubprocessFlags> for SubprocessFlags

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

Returns the union of the two sets of flags.

type Output = SubprocessFlags

The resulting type after applying the | operator.

impl BitOrAssign<SubprocessFlags> for SubprocessFlags

fn bitor_assign(&mut self, other: SubprocessFlags)

Adds the set of flags.

impl BitXor<SubprocessFlags> for SubprocessFlags

fn bitxor(self, other: SubprocessFlags) -> SubprocessFlags

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

type Output = SubprocessFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<SubprocessFlags> for SubprocessFlags

fn bitxor_assign(&mut self, other: SubprocessFlags)

Toggles the set of flags.

impl Clone for SubprocessFlags

fn clone(&self) -> SubprocessFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubprocessFlags

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

Formats the value using the given formatter.

impl Display for SubprocessFlags

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

Formats the value using the given formatter.

impl Extend<SubprocessFlags> for SubprocessFlags

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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.

impl FromIterator<SubprocessFlags> for SubprocessFlags

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

Creates a value from an iterator.

impl<'a> FromValue<'a> for SubprocessFlags

type Checker = GenericValueTypeChecker<Self>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl Hash for SubprocessFlags

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.

impl LowerHex for SubprocessFlags

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

Formats the value using the given formatter.

impl Not for SubprocessFlags

fn not(self) -> SubprocessFlags

Returns the complement of this set of flags.

type Output = SubprocessFlags

The resulting type after applying the ! operator.

impl Octal for SubprocessFlags

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

Formats the value using the given formatter.

impl Ord for SubprocessFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SubprocessFlags> for SubprocessFlags

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

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

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

This method tests for !=.

impl PartialOrd<SubprocessFlags> for SubprocessFlags

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

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

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

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

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

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

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

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

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

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

impl StaticType for SubprocessFlags

fn static_type() -> Type

Returns the type identifier of Self.

impl Sub<SubprocessFlags> for SubprocessFlags

fn sub(self, other: SubprocessFlags) -> SubprocessFlags

Returns the set difference of the two sets of flags.

type Output = SubprocessFlags

The resulting type after applying the - operator.

impl SubAssign<SubprocessFlags> for SubprocessFlags

fn sub_assign(&mut self, other: SubprocessFlags)

Disables all flags enabled in the set.

impl ToValue for SubprocessFlags

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifer of self.

impl UpperHex for SubprocessFlags

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

Formats the value using the given formatter.

impl ValueType for SubprocessFlags

type Type = Self

Type to get the Type from.

impl Copy for SubprocessFlags

impl Eq for SubprocessFlags

impl StructuralEq for SubprocessFlags

impl StructuralPartialEq for SubprocessFlags