Struct std::thread::Thread

A structure representing an Alumina thread.

Fields

• inner: &mut ThreadInfo

Methods

• fn current() -> Thread

  source

  Returns the current thread

  If the current thread is a foreign thread (e.g. not spawned using spawnor a main thread of a program with a non-Alumina entrypoint), this function will panic.

• fn id(self: &Thread) -> pthread_t

  source

  Returns the native thread id of a thread.

• fn park()

  source

  Suspends the current thread until another thread calls unpark.

  If the thread was unparked before the park function is called, this function will return immediately. It may also return spuriously, so care must be taken if it is used as a synchronization primitive.

  The purpose of this function is to efficiently wait on a condition and can be more lightweight than a CondVar on some platforms.

  This is the same mechanism as Rust's thread parking.

  Example

  use std::sync::{Atomic, Ordering};
  use std::thread::{Thread, spawn, sleep};
  use std::time::Duration;
  
  let flag: Atomic<bool> = Atomic::new(false);
  let parked = spawn(|&flag| {
      while !flag.load(Ordering::SeqCst) {
          Thread::park();
      }
      println!("Hello from `parked`");
  });
  
  sleep(Duration::from_secs(1));
  println!("Hello from `parked`");
  
  flag.store(true, Ordering::SeqCst);
  parked.thread().unpark();
  
  parked.join().unwrap();
  Run this example

• fn park_timeout(timeout: Duration)

  source

  Suspends the current thread until another thread calls unpark or until the specified duration has elapsed.

  Same as park, but the thread will be unparked after the specified duration.

• fn unpark(self: &Thread)

  source

  Resumes the execution of a thread that was previously parked.

  See also park.

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

  source

  Returns true if arguments are equal, false otherwise

  See Equatable for details.

• fn hash<H>(self: &Thread, hasher: &mut H)

  H: Hasher<H>

  source

  Update hasher state with the contents of this object.

  See Hashable for details.

Mixins

• mixin Equatable<Thread>

• fn not_equals(lhs: &Self, rhs: &Self) -> bool

  source

  Returns false if arguments are equal, true otherwise