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
impl SubprocessFlags
sourcepub const STDIN_PIPE: Self = _
pub const STDIN_PIPE: Self = _
create a pipe for the stdin of the
spawned process that can be accessed with
Subprocess::stdin_pipe()
.
sourcepub const STDIN_INHERIT: Self = _
pub const STDIN_INHERIT: Self = _
stdin is inherited from the calling process.
sourcepub const STDOUT_PIPE: Self = _
pub const STDOUT_PIPE: Self = _
create a pipe for the stdout of the
spawned process that can be accessed with
Subprocess::stdout_pipe()
.
sourcepub const STDOUT_SILENCE: Self = _
pub const STDOUT_SILENCE: Self = _
silence the stdout of the spawned
process (ie: redirect to /dev/null
).
sourcepub const STDERR_PIPE: Self = _
pub const STDERR_PIPE: Self = _
create a pipe for the stderr of the
spawned process that can be accessed with
Subprocess::stderr_pipe()
.
sourcepub const STDERR_SILENCE: Self = _
pub const STDERR_SILENCE: Self = _
silence the stderr of the spawned
process (ie: redirect to /dev/null
).
sourcepub const STDERR_MERGE: Self = _
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.
sourcepub const INHERIT_FDS: Self = _
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).
sourcepub const SEARCH_PATH_FROM_ENVP: Self = _
Available on crate feature v2_72
only.
pub const SEARCH_PATH_FROM_ENVP: Self = _
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
impl SubprocessFlags
sourcepub const fn from_bits(bits: u32) -> Option<Self>
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.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const fn from_bits_retain(bits: u32) -> Self
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).
sourcepub fn from_name(name: &str) -> Option<Self>
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.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn insert(&mut self, other: Self)
pub fn insert(&mut self, other: Self)
Inserts the specified flags in-place.
This method is equivalent to union
.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
Removes the specified flags in-place.
This method is equivalent to difference
.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
Toggles the specified flags in-place.
This method is equivalent to symmetric_difference
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
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.
sourcepub const fn union(self, other: Self) -> Self
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.
sourcepub const fn difference(self, other: Self) -> Self
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)
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
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.
sourcepub const fn complement(self) -> Self
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
impl SubprocessFlags
sourcepub const fn iter(&self) -> Iter<SubprocessFlags>
pub const fn iter(&self) -> Iter<SubprocessFlags>
Iterate over enabled flag values.
sourcepub const fn iter_names(&self) -> IterNames<SubprocessFlags>
pub const fn iter_names(&self) -> IterNames<SubprocessFlags>
Iterate over enabled flag values with their stringified names.
Trait Implementations§
source§impl Binary for SubprocessFlags
impl Binary for SubprocessFlags
source§impl BitAnd<SubprocessFlags> for SubprocessFlags
impl BitAnd<SubprocessFlags> for SubprocessFlags
source§impl BitAndAssign<SubprocessFlags> for SubprocessFlags
impl BitAndAssign<SubprocessFlags> for SubprocessFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<SubprocessFlags> for SubprocessFlags
impl BitOr<SubprocessFlags> for SubprocessFlags
source§fn bitor(self, other: SubprocessFlags) -> Self
fn bitor(self, other: SubprocessFlags) -> Self
Returns the union of the two sets of flags.
§type Output = SubprocessFlags
type Output = SubprocessFlags
|
operator.source§impl BitOrAssign<SubprocessFlags> for SubprocessFlags
impl BitOrAssign<SubprocessFlags> for SubprocessFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<SubprocessFlags> for SubprocessFlags
impl BitXor<SubprocessFlags> for SubprocessFlags
source§impl BitXorAssign<SubprocessFlags> for SubprocessFlags
impl BitXorAssign<SubprocessFlags> for SubprocessFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for SubprocessFlags
impl Clone for SubprocessFlags
source§fn clone(&self) -> SubprocessFlags
fn clone(&self) -> SubprocessFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for SubprocessFlags
impl Debug for SubprocessFlags
source§impl Display for SubprocessFlags
impl Display for SubprocessFlags
source§impl Extend<SubprocessFlags> for SubprocessFlags
impl Extend<SubprocessFlags> for SubprocessFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for SubprocessFlags
impl Flags for SubprocessFlags
source§const FLAGS: &'static [Flag<SubprocessFlags>] = _
const FLAGS: &'static [Flag<SubprocessFlags>] = _
source§fn from_bits_retain(bits: u32) -> SubprocessFlags
fn from_bits_retain(bits: u32) -> SubprocessFlags
source§fn from_bits(bits: Self::Bits) -> Option<Self>
fn from_bits(bits: Self::Bits) -> Option<Self>
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere Self: Sized,
true
if there are flags common to both self
and other
.source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere Self: Sized,
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where Self: Sized,
source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where Self: Sized,
source§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where Self: Sized,
source§fn set(&mut self, other: Self, value: bool)where
Self: Sized,
fn set(&mut self, other: Self, value: bool)where Self: Sized,
source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
self
and other
.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
self
and other
.source§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
self
and other
.source§fn complement(self) -> Self
fn complement(self) -> Self
source§impl From<SubprocessFlags> for Value
impl From<SubprocessFlags> for Value
source§fn from(v: SubprocessFlags) -> Self
fn from(v: SubprocessFlags) -> Self
source§impl FromIterator<SubprocessFlags> for SubprocessFlags
impl FromIterator<SubprocessFlags> for SubprocessFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl<'a> FromValue<'a> for SubprocessFlags
impl<'a> FromValue<'a> for SubprocessFlags
§type Checker = GenericValueTypeChecker<SubprocessFlags>
type Checker = GenericValueTypeChecker<SubprocessFlags>
source§unsafe fn from_value(value: &'a Value) -> Self
unsafe fn from_value(value: &'a Value) -> Self
Value
. Read moresource§impl HasParamSpec for SubprocessFlags
impl HasParamSpec for SubprocessFlags
type ParamSpec = ParamSpecFlags
§type SetValue = SubprocessFlags
type SetValue = SubprocessFlags
type BuilderFn = fn(_: &str) -> ParamSpecFlagsBuilder<'_, SubprocessFlags>
fn param_spec_builder() -> Self::BuilderFn
source§impl Hash for SubprocessFlags
impl Hash for SubprocessFlags
source§impl IntoIterator for SubprocessFlags
impl IntoIterator for SubprocessFlags
source§impl LowerHex for SubprocessFlags
impl LowerHex for SubprocessFlags
source§impl Not for SubprocessFlags
impl Not for SubprocessFlags
source§impl Octal for SubprocessFlags
impl Octal for SubprocessFlags
source§impl PartialEq<SubprocessFlags> for SubprocessFlags
impl PartialEq<SubprocessFlags> for SubprocessFlags
source§fn eq(&self, other: &SubprocessFlags) -> bool
fn eq(&self, other: &SubprocessFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for SubprocessFlags
impl PublicFlags for SubprocessFlags
source§impl StaticType for SubprocessFlags
impl StaticType for SubprocessFlags
source§fn static_type() -> Type
fn static_type() -> Type
Self
.source§impl Sub<SubprocessFlags> for SubprocessFlags
impl Sub<SubprocessFlags> for SubprocessFlags
source§impl SubAssign<SubprocessFlags> for SubprocessFlags
impl SubAssign<SubprocessFlags> for SubprocessFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
source§impl ToValue for SubprocessFlags
impl ToValue for SubprocessFlags
source§impl UpperHex for SubprocessFlags
impl UpperHex for SubprocessFlags
source§impl ValueType for SubprocessFlags
impl ValueType for SubprocessFlags
§type Type = SubprocessFlags
type Type = SubprocessFlags
Type
from. Read moreimpl Copy for SubprocessFlags
impl Eq for SubprocessFlags
impl StructuralEq for SubprocessFlags
impl StructuralPartialEq for SubprocessFlags
Auto Trait Implementations§
impl RefUnwindSafe for SubprocessFlags
impl Send for SubprocessFlags
impl Sync for SubprocessFlags
impl Unpin for SubprocessFlags
impl UnwindSafe for SubprocessFlags
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoClosureReturnValue for Twhere
T: Into<Value>,
impl<T> IntoClosureReturnValue for Twhere T: Into<Value>,
fn into_closure_return_value(self) -> Option<Value>
source§impl<T> PropertyGet for Twhere
T: HasParamSpec,
impl<T> PropertyGet for Twhere T: HasParamSpec,
source§impl<T> StaticTypeExt for Twhere
T: StaticType,
impl<T> StaticTypeExt for Twhere T: StaticType,
source§fn ensure_type()
fn ensure_type()
source§impl<T> ToSendValue for Twhere
T: Send + ToValue + ?Sized,
impl<T> ToSendValue for Twhere T: Send + ToValue + ?Sized,
source§fn to_send_value(&self) -> SendValue
fn to_send_value(&self) -> SendValue
SendValue
clone of self
.