Struct objc2::foundation::NSThread

source ·
#[repr(C)]
pub struct NSThread { /* private fields */ }
Expand description

A thread of execution.

See Apple’s documentation.

Implementations§

source§

impl NSThread

source

pub fn current() -> Id<Self, Shared>

Returns the NSThread object representing the current thread.

source

pub fn main() -> Id<NSThread, Shared>

Returns the NSThread object representing the main thread.

source

pub fn is_main(&self) -> bool

Returns true if the thread is the main thread.

source

pub fn name(&self) -> Option<Id<NSString, Shared>>

The name of the thread.

Methods from Deref<Target = NSObject>§

source

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>§

source

pub fn class(&self) -> &Class

Dynamically find the class of this object.

source

pub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T

Returns a pointer to the instance variable / ivar with the given name.

This is similar to UnsafeCell::get, see that for more information on what is and isn’t safe to do.

Usually you will have defined the instance variable yourself with ClassBuilder::add_ivar, the type of the ivar T must match the type used in that.

Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.

Library implementors are strongly encouraged to expose a safe interface to the ivar.

Panics

May panic if the object has no ivar with the given name. May also panic if the type encoding of the ivar differs from the type encoding of T.

This should purely seen as help while debugging and is not guaranteed (e.g. it may be disabled when debug_assertions are off).

Safety

The object must have an instance variable with the given name, and it must be of type T. Any invariants that the object have assumed about the value of the instance variable must not be violated.

No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.

source

pub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T

Returns a reference to the instance variable with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

No thread syncronization is done, so you must ensure that no other thread is concurrently mutating the variable. This requirement can be considered upheld if all mutation happens through Object::ivar_mut (since that takes &mut self).

source

pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

source

pub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T

Returns a mutable reference to the ivar with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

This access happens through &mut self, which means we know it to be the only reference, hence you do not need to do any work to ensure that data races do not happen.

source

pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated: Use Object::ivar_mut instead.
source

pub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)

Sets the value of the ivar with the given name.

This is just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations§

source§

impl AsMut<NSObject> for NSThread

source§

fn as_mut(&mut self) -> &mut NSObject

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl AsMut<NSThread> for NSThread

source§

fn as_mut(&mut self) -> &mut Self

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl AsMut<Object> for NSThread

source§

fn as_mut(&mut self) -> &mut Object

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl AsRef<NSObject> for NSThread

source§

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<NSThread> for NSThread

source§

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl AsRef<Object> for NSThread

source§

fn as_ref(&self) -> &Object

Converts this type into a shared reference of the (usually inferred) input type.
source§

impl Borrow<NSObject> for NSThread

source§

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value. Read more
source§

impl Borrow<Object> for NSThread

source§

fn borrow(&self) -> &Object

Immutably borrows from an owned value. Read more
source§

impl BorrowMut<NSObject> for NSThread

source§

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value. Read more
source§

impl BorrowMut<Object> for NSThread

source§

fn borrow_mut(&mut self) -> &mut Object

Mutably borrows from an owned value. Read more
source§

impl ClassType for NSThread

§

type Super = NSObject

The superclass of this class. Read more
source§

const NAME: &'static str = _

The name of the Objective-C class that this type represents.
source§

fn class() -> &'static Class

Get a reference to the Objective-C class that this type represents. Read more
source§

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.
source§

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.
source§

impl Debug for NSThread

source§

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

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

impl Deref for NSThread

§

type Target = NSObject

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for NSThread

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl Hash for NSThread

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 PartialEq<NSThread> for NSThread

source§

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

source§

const ENCODING_REF: Encoding = <NSObject as crate::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type. Read more
source§

impl Eq for NSThread

source§

impl Message for NSThread

source§

impl RefUnwindSafe for NSThread

source§

impl Send for NSThread

source§

impl StructuralEq for NSThread

source§

impl StructuralPartialEq for NSThread

source§

impl Sync for NSThread

source§

impl UnwindSafe for NSThread

Auto Trait Implementations§

§

impl !Unpin for NSThread

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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 Twhere 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 Twhere 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.
source§

impl<T> AutoreleaseSafe for Twhere T: ?Sized,