Struct zircon_object::object::Rights

pub struct Rights { /* fields omitted */ }

Rights are associated with handles and convey privileges to perform actions on either the associated handle or the object associated with the handle.

Implementations

impl Rights

pub const DUPLICATE: Rights

Allows handle duplication via zx_handle_duplicate().

pub const TRANSFER: Rights

Allows handle transfer via zx_channel_write().

pub const READ: Rights

Allows reading of data from containers (channels, sockets, VM objects, etc). Allows mapping as readable if Rights::MAP is also present.

pub const WRITE: Rights

Allows writing of data to containers (channels, sockets, VM objects, etc). Allows mapping as writeable if Rights::MAP is also present.

pub const EXECUTE: Rights

Allows mapping as executable if Rights::MAP is also present.

pub const MAP: Rights

Allows mapping of a VM object into an address space.

pub const GET_PROPERTY: Rights

Allows property inspection via zx_object_get_property().

pub const SET_PROPERTY: Rights

Allows property modification via zx_object_set_property().

pub const ENUMERATE: Rights

Allows enumerating child objects via zx_object_get_info() and zx_object_get_child().

pub const DESTROY: Rights

Allows termination of task objects via zx_task_kill().

pub const SET_POLICY: Rights

Allows policy modification via zx_job_set_policy().

pub const GET_POLICY: Rights

Allows policy inspection via zx_job_get_policy().

pub const SIGNAL: Rights

Allows use of zx_object_signal().

pub const SIGNAL_PEER: Rights

Allows use of zx_object_signal_peer().

pub const WAIT: Rights

Allows use of zx_object_wait_one(), zx_object_wait_many(), and other waiting primitives.

pub const INSPECT: Rights

Allows inspection via zx_object_get_info().

pub const MANAGE_JOB: Rights

Allows creation of processes, subjobs, etc.

pub const MANAGE_PROCESS: Rights

Allows creation of threads, etc.

pub const MANAGE_THREAD: Rights

Allows suspending/resuming threads, etc.

pub const APPLY_PROFILE: Rights

Not used.

pub const SAME_RIGHTS: Rights

Used to duplicate a handle with the same rights.

pub const BASIC: Rights

TRANSFER | DUPLICATE | WAIT | INSPECT

pub const IO: Rights

READ ｜ WRITE

pub const PROPERTY: Rights

GET_PROPERTY ｜ SET_PROPERTY

pub const POLICY: Rights

GET_POLICY ｜ SET_POLICY

pub const DEFAULT_CHANNEL: Rights

BASIC & !Self::DUPLICATE | IO | SIGNAL | SIGNAL_PEER

pub const DEFAULT_PROCESS: Rights

BASIC | IO | PROPERTY | ENUMERATE | DESTROY | SIGNAL | MANAGE_PROCESS | MANAGE_THREAD

pub const DEFAULT_THREAD: Rights

BASIC | IO | PROPERTY | DESTROY | SIGNAL | MANAGE_THREAD

pub const DEFAULT_VMO: Rights

BASIC | IO | PROPERTY | MAP | SIGNAL

pub const DEFAULT_VMAR: Rights

BASIC | WAIT

pub const DEFAULT_JOB: Rights

BASIC | IO | PROPERTY | POLICY | ENUMERATE | DESTROY | SIGNAL | MANAGE_JOB | MANAGE_PROCESS | MANAGE_THREAD

pub const DEFAULT_RESOURCE: Rights

TRANSFER | DUPLICATE | WRITE | INSPECT

pub const DEFAULT_DEBUGLOG: Rights

BASIC | WRITE | SIGNAL

pub const DEFAULT_SUSPEND_TOKEN: Rights

TRANSFER | INSPECT

pub const DEFAULT_PORT: Rights

(BASIC & !WAIT) | IO

pub const DEFAULT_TIMER: Rights

BASIC | WRITE | SIGNAL

pub const DEFAULT_EVENT: Rights

BASIC | SIGNAL

pub const DEFAULT_EVENTPAIR: Rights

BASIC | SIGNAL ｜ SIGNAL_PEER

pub const DEFAULT_FIFO: Rights

BASIC | IO | SIGNAL | SIGNAL_PEER

pub const DEFAULT_SOCKET: Rights

BASIC | IO | PROPERTY | SIGNAL | SIGNAL_PEER

pub const DEFAULT_STREAM: Rights

BASIC | PROPERTY | SIGNAL

pub const DEFAULT_BTI: Rights

(BASIC & !WAIT) | IO | MAP

pub const DEFAULT_INTERRUPT: Rights

BASIC | IO | SIGNAL

pub const DEFAULT_DEVICE: Rights

BASIC | IO

pub const DEFAULT_PCI_INTERRUPT: Rights

BASIC | IO | SIGNAL

pub const DEFAULT_EXCEPTION: Rights

TRANSFER | PROPERTY | INSPECT

pub const DEFAULT_GUEST: Rights

TRANSFER | DUPLICATE | WRITE | INSPECT | MANAGE_PROCESS

pub const DEFAULT_VCPU: Rights

BASIC | IO | EXECUTE | SIGNAL

pub const fn empty() -> Rights

Returns an empty set of flags

pub const fn all() -> Rights

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<Rights>

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

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for Rights

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

Formats the value using the given formatter.

impl BitAnd<Rights> for Rights

type Output = Rights

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<Rights> for Rights

fn bitand_assign(&mut self, other: Rights)

Disables all flags disabled in the set.

impl BitOr<Rights> for Rights

type Output = Rights

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<Rights> for Rights

fn bitor_assign(&mut self, other: Rights)

Adds the set of flags.

impl BitXor<Rights> for Rights

type Output = Rights

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<Rights> for Rights

fn bitxor_assign(&mut self, other: Rights)

Toggles the set of flags.

impl Clone for Rights

fn clone(&self) -> Rights

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Rights

impl Debug for Rights

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

Formats the value using the given formatter.

impl Default for Rights

fn default() -> Rights

Returns the “default value” for a type.

impl Eq for Rights

impl Extend<Rights> for Rights

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

Extends a collection with the contents of an iterator.

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

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

Extends a collection with exactly one element.

pub 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<Rights> for Rights

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

Creates a value from an iterator.

impl Hash for Rights

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 Rights

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

Formats the value using the given formatter.

impl Not for Rights

type Output = Rights

The resulting type after applying the ! operator.

fn not(self) -> Rights

Returns the complement of this set of flags.

impl Octal for Rights

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

Formats the value using the given formatter.

impl Ord for Rights

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Rights> for Rights

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

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

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

This method tests for !=.

impl PartialOrd<Rights> for Rights

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for Rights

impl StructuralPartialEq for Rights

impl Sub<Rights> for Rights

type Output = Rights

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Rights> for Rights

fn sub_assign(&mut self, other: Rights)

Disables all flags enabled in the set.

impl TryFrom<u32> for Rights

type Error = ZxError

The type returned in the event of a conversion error.

fn try_from(x: u32) -> ZxResult<Self>

Performs the conversion.

impl UpperHex for Rights

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

Formats the value using the given formatter.