Struct gio::SubprocessFlags

source ·
pub struct SubprocessFlags(_);
Expand description

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§

source§

impl SubprocessFlags

source

pub const NONE: Self = _

No flags.

source

pub const STDIN_PIPE: Self = _

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

source

pub const STDIN_INHERIT: Self = _

stdin is inherited from the calling process.

source

pub const STDOUT_PIPE: Self = _

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

source

pub const STDOUT_SILENCE: Self = _

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

source

pub const STDERR_PIPE: Self = _

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

source

pub const STDERR_SILENCE: Self = _

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

source

pub const STDERR_MERGE: Self = _

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.

source

pub const INHERIT_FDS: Self = _

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).

source

pub const SEARCH_PATH_FROM_ENVP: Self = _

Available on crate feature v2_72 only.

if path searching is needed when spawning the subprocess, use the PATH in the launcher environment. (Since: 2.72)

source§

impl SubprocessFlags

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) -> u32

Returns the raw value of the flags currently stored.

source

pub const fn from_bits(bits: u32) -> 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: u32) -> Self

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

source

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

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

source

pub fn from_name(name: &str) -> Option<Self>

Get the value for a flag from its stringified name.

Names are case-sensitive, so must correspond exactly to the identifier given to the flag.

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.

This method is equivalent to union.

source

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

Removes the specified flags in-place.

This method is equivalent to difference.

source

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

Toggles the specified flags in-place.

This method is equivalent to symmetric_difference.

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.

Calculating self bitwise and (&) other, including any bits that don’t correspond to a defined flag.

source

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

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

Calculates self bitwise or (|) other, including any bits that don’t correspond to a defined flag.

source

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

Returns the difference between the flags in self and other.

Calculates self bitwise and (&!) the bitwise negation of other, including any bits that don’t correspond to a defined flag.

This method is not equivalent to a & !b when there are bits set that don’t correspond to a defined flag. The ! operator will unset any bits that don’t correspond to a flag, so they’ll always be unset by a &! b, but respected by a.difference(b).

source

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

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

Calculates self bitwise exclusive or (^) other, including any bits that don’t correspond to a defined flag.

source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Calculates the bitwise negation (!) of self, unsetting any bits that don’t correspond to a defined flag.

source§

impl SubprocessFlags

source

pub const fn iter(&self) -> Iter<SubprocessFlags>

Iterate over enabled flag values.

source

pub const fn iter_names(&self) -> IterNames<SubprocessFlags>

Iterate over enabled flag values with their stringified names.

Trait Implementations§

source§

impl Binary for SubprocessFlags

source§

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

Formats the value using the given formatter.
source§

impl BitAnd<SubprocessFlags> for SubprocessFlags

source§

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

Returns the intersection between the two sets of flags.

§

type Output = SubprocessFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign<SubprocessFlags> for SubprocessFlags

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr<SubprocessFlags> for SubprocessFlags

source§

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

Returns the union of the two sets of flags.

§

type Output = SubprocessFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign<SubprocessFlags> for SubprocessFlags

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor<SubprocessFlags> for SubprocessFlags

source§

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

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

§

type Output = SubprocessFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<SubprocessFlags> for SubprocessFlags

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for SubprocessFlags

source§

fn clone(&self) -> SubprocessFlags

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 SubprocessFlags

source§

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

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

impl Display for SubprocessFlags

source§

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

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

impl Extend<SubprocessFlags> for SubprocessFlags

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 Flags for SubprocessFlags

source§

const FLAGS: &'static [Flag<SubprocessFlags>] = _

The set of available flags and their names.
§

type Bits = u32

The underlying storage type.
source§

fn bits(&self) -> u32

Returns the raw value of the flags currently stored.
source§

fn from_bits_retain(bits: u32) -> SubprocessFlags

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

fn empty() -> Self

Returns an empty set of flags.
source§

fn all() -> Self

Returns the set containing all flags.
source§

fn from_bits(bits: Self::Bits) -> Option<Self>

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

fn from_bits_truncate(bits: Self::Bits) -> Self

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

fn from_name(name: &str) -> Option<Self>

Get the flag for a particular name.
source§

fn iter(&self) -> Iter<Self>

Iterate over enabled flag values.
source§

fn iter_names(&self) -> IterNames<Self>

Iterate over the raw names and bits for enabled flag values.
source§

fn is_empty(&self) -> bool

Returns true if no flags are currently stored.
source§

fn is_all(&self) -> bool

Returns true if all flags are currently set.
source§

fn intersects(&self, other: Self) -> boolwhere Self: Sized,

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

fn contains(&self, other: Self) -> boolwhere Self: Sized,

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

fn insert(&mut self, other: Self)where Self: Sized,

Inserts the specified flags in-place. Read more
source§

fn remove(&mut self, other: Self)where Self: Sized,

Removes the specified flags in-place. Read more
source§

fn toggle(&mut self, other: Self)where Self: Sized,

Toggles the specified flags in-place. Read more
source§

fn set(&mut self, other: Self, value: bool)where Self: Sized,

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

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

Returns the intersection between the flags in self and other.
source§

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

Returns the union of between the flags in self and other.
source§

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

Returns the difference between the flags in self and other.
source§

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

Returns the symmetric difference between the flags in self and other.
source§

fn complement(self) -> Self

Returns the complement of this set of flags.
source§

impl From<SubprocessFlags> for Value

source§

fn from(v: SubprocessFlags) -> Self

Converts to this type from the input type.
source§

impl FromIterator<SubprocessFlags> for SubprocessFlags

source§

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

Creates a value from an iterator. Read more
source§

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

§

type Checker = GenericValueTypeChecker<SubprocessFlags>

Value type checker.
source§

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

Get the contained value from a Value. Read more
source§

impl HasParamSpec for SubprocessFlags

§

type ParamSpec = ParamSpecFlags

§

type SetValue = SubprocessFlags

Preferred value to be used as setter for the associated ParamSpec.
§

type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, SubprocessFlags>

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for SubprocessFlags

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 IntoIterator for SubprocessFlags

§

type Item = SubprocessFlags

The type of the elements being iterated over.
§

type IntoIter = Iter<SubprocessFlags>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl LowerHex for SubprocessFlags

source§

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

Formats the value using the given formatter.
source§

impl Not for SubprocessFlags

source§

fn not(self) -> Self

Returns the complement of this set of flags.

§

type Output = SubprocessFlags

The resulting type after applying the ! operator.
source§

impl Octal for SubprocessFlags

source§

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

Formats the value using the given formatter.
source§

impl PartialEq<SubprocessFlags> for SubprocessFlags

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PublicFlags for SubprocessFlags

§

type Primitive = u32

The type of the underlying storage.
§

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.
source§

impl StaticType for SubprocessFlags

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Sub<SubprocessFlags> for SubprocessFlags

source§

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

Returns the set difference of the two sets of flags.

§

type Output = SubprocessFlags

The resulting type after applying the - operator.
source§

impl SubAssign<SubprocessFlags> for SubprocessFlags

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl ToValue for SubprocessFlags

source§

fn to_value(&self) -> Value

Convert a value to a Value.
source§

fn value_type(&self) -> Type

Returns the type identifer of self. Read more
source§

impl UpperHex for SubprocessFlags

source§

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

Formats the value using the given formatter.
source§

impl ValueType for SubprocessFlags

§

type Type = SubprocessFlags

Type to get the Type from. Read more
source§

impl Copy for SubprocessFlags

source§

impl Eq for SubprocessFlags

source§

impl StructuralEq for SubprocessFlags

source§

impl StructuralPartialEq for SubprocessFlags

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<B> BitFlags for Bwhere B: Flags,

§

type Iter = Iter<B>

👎Deprecated: use the Flags trait instead
An iterator over enabled flags in an instance of the type.
§

type IterNames = IterNames<B>

👎Deprecated: use the Flags trait instead
An iterator over the raw names and bits for enabled flags in an instance of the type.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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> IntoClosureReturnValue for Twhere T: Into<Value>,

source§

impl<T> Property for Twhere T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for Twhere T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> Rwhere F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for Twhere T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for Twhere 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> ToSendValue for Twhere T: Send + ToValue + ?Sized,

source§

fn to_send_value(&self) -> SendValue

Returns a SendValue clone of self.
source§

impl<T> ToString for Twhere T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for Twhere T: for<'a> FromValue<'a> + StaticType + 'static,

source§

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

§

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.