Struct fuchsia_zircon::Thread

source ·
pub struct Thread(/* private fields */);
Expand description

An object representing a Zircon thread.

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

Implementations§

source§

impl Thread

source

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.

source

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.

source

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.

source

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

Wraps the zx_object_get_info syscall for the ZX_INFO_THREAD_EXCEPTION_REPORT topic.

source

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

Wraps the zx_object_get_info syscall for the ZX_INFO_THREAD_STATS topic.

source

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

source

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

source

pub fn raise_exception( options: RaiseExceptionOptions, exception_type: zx_excp_type_t, context: zx_exception_context_t ) -> Result<(), Status>

source

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

source§

impl Thread

source

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

source§

impl Thread

source

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

Trait Implementations§

source§

impl AsHandleRef for Thread

source§

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

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

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

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.
source§

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

Waits on a handle. Wraps the zx_object_wait_one syscall.
source§

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.
source§

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

Get the Property::NAME property for this object. Read more
source§

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

Set the Property::NAME property for this object. Read more
source§

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_BASIC topic.
source§

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

Wraps the zx_object_get_info syscall for the ZX_INFO_HANDLE_COUNT topic.
source§

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

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

impl Debug for Thread

source§

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

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

impl From<Handle> for Thread

source§

fn from(handle: Handle) -> Self

Converts to this type from the input type.
source§

impl From<Thread> for Handle

source§

fn from(x: Thread) -> Handle

Converts to this type from the input type.
source§

impl HandleBased for Thread

source§

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

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

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.
source§

fn into_handle(self) -> Handle

Converts the value into its inner handle. Read more
source§

fn into_raw(self) -> zx_handle_t

Converts the handle into it’s raw representation. Read more
source§

fn from_handle(handle: Handle) -> Self

Creates an instance of this type from a handle. Read more
source§

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

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

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

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

fn is_invalid_handle(&self) -> bool

source§

impl Hash for Thread

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 Ord for Thread

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl PartialEq for Thread

source§

fn eq(&self, other: &Thread) -> 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 PartialOrd for Thread

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Task for Thread

source§

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

Kill the given task (job, process, or thread). Read more
source§

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

Suspend the given task Read more
source§

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

Create an exception channel (with options) for the task. Read more
source§

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

Create an exception channel for the task. Read more
source§

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

Returns the runtime information for the task. Read more
source§

impl Eq for Thread

source§

impl StructuralPartialEq for Thread

Auto Trait Implementations§

§

impl Freeze for Thread

§

impl RefUnwindSafe for Thread

§

impl Send for Thread

§

impl Sync for Thread

§

impl Unpin for Thread

§

impl UnwindSafe for Thread

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where 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 T
where 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, U> TryFrom<U> for T
where 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, U> TryInto<U> for T
where 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.