Struct nix::sched::CloneFlags

pub struct CloneFlags { /* fields hidden */ }
Documentation

Options for use with clone

Implementations

impl CloneFlags
const CLONE_VM: Self = _

The calling process and the child process run in the same memory space.

const CLONE_FS: Self = _

The caller and the child process share the same filesystem information.

const CLONE_FILES: Self = _

The calling process and the child process share the same file descriptor table.

const CLONE_SIGHAND: Self = _

The calling process and the child process share the same table of signal handlers.

const CLONE_PTRACE: Self = _

If the calling process is being traced, then trace the child also.

const CLONE_VFORK: Self = _

The execution of the calling process is suspended until the child releases its virtual memory resources via a call to execve(2) or _exit(2) (as with vfork(2)).

const CLONE_PARENT: Self = _

The parent of the new child (as returned by getppid(2)) will be the same as that of the calling process.

const CLONE_THREAD: Self = _

The child is placed in the same thread group as the calling process.

const CLONE_NEWNS: Self = _

The cloned child is started in a new mount namespace.

const CLONE_SYSVSEM: Self = _

The child and the calling process share a single list of System V semaphore adjustment values

const CLONE_DETACHED: Self = _

Unused since Linux 2.6.2

const CLONE_UNTRACED: Self = _

A tracing process cannot force CLONE_PTRACE on this child process.

const CLONE_NEWCGROUP: Self = _

Create the process in a new cgroup namespace.

const CLONE_NEWUTS: Self = _

Create the process in a new UTS namespace.

const CLONE_NEWIPC: Self = _

Create the process in a new IPC namespace.

const CLONE_NEWUSER: Self = _

Create the process in a new user namespace.

const CLONE_NEWPID: Self = _

Create the process in a new PID namespace.

const CLONE_NEWNET: Self = _

Create the process in a new network namespace.

const CLONE_IO: Self = _

The new process shares an I/O context with the calling process.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&Self) -> c_int

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: c_int) -> $crate::_core::option::Option<Self>

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

pub const fn from_bits_truncate(bits: c_int) -> Self

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

pub const unsafe fn from_bits_unchecked(bits: c_int) -> 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.

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: Self) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

#[must_use]
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.

#[must_use]
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.

#[must_use]
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.

#[must_use]
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.

#[must_use]
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

impl BitAnd<CloneFlags> for CloneFlags
type Output = CloneFlags
fn bitand(Self, other: Self) -> Self

Returns the intersection between the two sets of flags.

impl BitAndAssign<CloneFlags> for CloneFlags
fn bitand_assign(&mut Self, other: Self)

Disables all flags disabled in the set.

impl BitOr<CloneFlags> for CloneFlags
type Output = CloneFlags
fn bitor(Self, other: CloneFlags) -> Self

Returns the union of the two sets of flags.

impl BitOrAssign<CloneFlags> for CloneFlags
fn bitor_assign(&mut Self, other: Self)

Adds the set of flags.

impl BitXor<CloneFlags> for CloneFlags
type Output = CloneFlags
fn bitxor(Self, other: Self) -> Self

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

impl BitXorAssign<CloneFlags> for CloneFlags
fn bitxor_assign(&mut Self, other: Self)

Toggles the set of flags.

impl Clone for CloneFlags
fn clone(&Self) -> CloneFlags
impl Copy for CloneFlags
impl Eq for CloneFlags
impl Extend<CloneFlags> for CloneFlags
fn extend<T: $crate::_core::iter::IntoIterator<Item = Self>>(&mut Self, iterator: T)
impl FromIterator<CloneFlags> for CloneFlags
fn from_iter<T: $crate::_core::iter::IntoIterator<Item = Self>>(iterator: T) -> Self
impl Hash for CloneFlags
fn hash<__H: $crate::hash::Hasher>(&Self, state: &mut __H) -> ()
impl Not for CloneFlags
type Output = CloneFlags
fn not(Self) -> Self

Returns the complement of this set of flags.

impl Ord for CloneFlags
fn cmp(&Self, other: &CloneFlags) -> $crate::cmp::Ordering
impl PartialEq<CloneFlags> for CloneFlags
fn eq(&Self, other: &CloneFlags) -> bool
fn ne(&Self, other: &CloneFlags) -> bool
impl Sub<CloneFlags> for CloneFlags
type Output = CloneFlags
fn sub(Self, other: Self) -> Self

Returns the set difference of the two sets of flags.

impl SubAssign<CloneFlags> for CloneFlags
fn sub_assign(&mut Self, other: Self)

Disables all flags enabled in the set.

Auto Trait Implementations

impl Send for CloneFlags
impl Sync for CloneFlags
impl Unpin for CloneFlags

Blanket Implementations

impl<T> Any for T
where
    T: 'static + ?Sized,
fn type_id(&Self) -> TypeId
impl<T> Borrow<T> for T
where
    T: ?Sized,
fn borrow(&Self) -> &T
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
fn borrow_mut(&mut Self) -> &mut T
impl<T> From<T> for T
fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where
    U: From<T>,
fn into(Self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where
    T: Clone,
type Owned = T
fn to_owned(&Self) -> T
fn clone_into(&Self, target: &mut T)
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
type Error = Infallible
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
fn try_into(Self) -> Result<U, <U as TryFrom<T>>::Error>