Struct Thread

pub struct Thread(/* private fields */);

An object representing a Zircon thread.

As essentially a subtype of Handle, it can be freely interconverted.

Implementations

impl Thread

pub fn start( &self, thread_entry: usize, stack: usize, arg1: usize, arg2: usize, ) -> Result<(), Status>

Cause the thread to begin execution.

Wraps the zx_thread_start syscall.

pub fn set_profile(&self, profile: Profile, options: u32) -> Result<(), Status>

Apply a scheduling profile to a thread.

Wraps the zx_object_set_profile syscall.

pub unsafe fn exit()

Terminate the current running thread.

Safety

Extreme caution should be used– this is basically always UB in Rust. There’s almost no “normal” program code where this is okay to call. Users should take care that no references could possibly exist to stack variables on this thread, and that any destructors, closure suffixes, or other “after this thing runs” code is waiting to run in order for safety.

pub fn get_exception_report(&self) -> Result<ExceptionReport, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_THREAD_EXCEPTION_REPORT topic.

pub fn get_thread_info(&self) -> Result<ThreadInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_THREAD topic.

pub fn get_stats(&self) -> Result<ThreadStats, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_THREAD_STATS topic.

pub fn read_state_general_regs( &self, ) -> Result<zx_thread_state_general_regs_t, Status>

pub fn write_state_general_regs( &self, state: zx_thread_state_general_regs_t, ) -> Result<(), Status>

pub fn raise_user_exception( options: RaiseExceptionOptions, synth_code: u32, synth_data: u32, ) -> Result<(), Status>

Wraps the zx_thread_raise_exception syscall.

See https://fuchsia.dev/reference/syscalls/thread_raise_exception?hl=en for details.

impl Thread

pub fn set_register_gs(&self, val: &usize) -> Result<(), Status>

impl Thread

pub fn set_register_fs(&self, val: &usize) -> Result<(), Status>

Trait Implementations

impl AsHandleRef for Thread

fn as_handle_ref(&self) -> HandleRef<'_>

Get a reference to the handle. One important use of such a reference is for object_wait_many.

fn raw_handle(&self) -> zx_handle_t

Interpret the reference as a raw handle (an integer type). Two distinct handles will have different raw values (so it can perhaps be used as a key in a data structure).

fn signal_handle( &self, clear_mask: Signals, set_mask: Signals, ) -> Result<(), Status>

Set and clear userspace-accessible signal bits on an object. Wraps the zx_object_signal syscall.

fn wait_handle( &self, signals: Signals, deadline: MonotonicInstant, ) -> Result<Signals, Status>

Waits on a handle. Wraps the zx_object_wait_one syscall.

fn wait_async_handle( &self, port: &Port, key: u64, signals: Signals, options: WaitAsyncOpts, ) -> Result<(), Status>

Causes packet delivery on the given port when the object changes state and matches signals. zx_object_wait_async syscall.

fn get_name(&self) -> Result<Name, Status>

Get the Property::NAME property for this object.

fn set_name(&self, name: &Name) -> Result<(), Status>

Set the Property::NAME property for this object.

fn basic_info(&self) -> Result<HandleBasicInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.

fn count_info(&self) -> Result<HandleCountInfo, Status>

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.

fn get_koid(&self) -> Result<Koid, Status>

Returns the koid (kernel object ID) for this handle.

impl Debug for Thread

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

Formats the value using the given formatter.

impl From<Handle> for Thread

fn from(handle: Handle) -> Self

Converts to this type from the input type.

impl From<Thread> for Handle

fn from(x: Thread) -> Handle

Converts to this type from the input type.

impl HandleBased for Thread

fn duplicate_handle(&self, rights: Rights) -> Result<Self, Status>

Duplicate a handle, possibly reducing the rights available. Wraps the zx_handle_duplicate syscall.

fn replace_handle(self, rights: Rights) -> Result<Self, Status>

Create a replacement for a handle, possibly reducing the rights available. This invalidates the original handle. Wraps the zx_handle_replace syscall.

fn into_handle(self) -> Handle

Converts the value into its inner handle.

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation.

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle.

fn into_handle_based<H: HandleBased>(self) -> H

Creates an instance of another handle-based type from this value’s inner handle.

fn from_handle_based<H: HandleBased>(h: H) -> Self

Creates an instance of this type from the inner handle of another handle-based type.

fn is_invalid_handle(&self) -> bool

impl Hash for Thread

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Thread

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Thread

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Thread

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Task for Thread

fn kill(&self) -> Result<(), Status>

Kill the given task (job, process, or thread).

fn suspend(&self) -> Result<Handle, Status>

Suspend the given task

fn create_exception_channel_with_opts( &self, opts: ExceptionChannelOptions, ) -> Result<Channel, Status>

Create an exception channel (with options) for the task.

fn create_exception_channel(&self) -> Result<Channel, Status>

Create an exception channel for the task.

fn get_runtime_info(&self) -> Result<TaskRuntimeInfo, Status>

Returns the runtime information for the task.

impl Eq for Thread

impl StructuralPartialEq for Thread