Skip to main content

ThreadScope

devela::work::exec::thread

Struct ThreadScope

1.63.0 · Source

pub struct ThreadScope<'scope, 'env>where
    'env: 'scope,
{ /* private fields */ }

Available on crate features std only.

Expand description

🧵 std A scope to spawn scoped threads in.

^📍^work/thread ^{re-exported from std::thread ::Scope as ThreadScope}

📜
A scope to spawn scoped threads in.

See scope for details.

Implementations§

impl<'scope, 'env> Scope<'scope, 'env>

1.63.0 · Source

pub fn spawn<F, T>(&'scope self, f: F) -> ScopedJoinHandle<'scope, T>
where F: FnOnce() -> T + Send + 'scope, T: Send + 'scope,

Spawns a new thread within a scope, returning a ScopedJoinHandle for it.

Unlike non-scoped threads, threads spawned with this function may borrow non-'static data from outside the scope. See scope for details.

The join handle provides a join method that can be used to join the spawned thread. If the spawned thread panics, join will return an Err containing the panic payload.

If the join handle is dropped, the spawned thread will be implicitly joined at the end of the scope. In that case, if the spawned thread panics, scope will panic after all threads are joined.

This function creates a thread with the default parameters of Builder. To specify the new thread’s stack size or the name, use Builder::spawn_scoped.

§Panics

Panics if the OS fails to create a thread; use Builder::spawn_scoped to recover from such errors.

Trait Implementations§

1.63.0 · Source§

impl Debug for Scope<'_, '_>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<'scope, 'env> !UnwindSafe for Scope<'scope, 'env>

impl<'scope, 'env> Freeze for Scope<'scope, 'env>

impl<'scope, 'env> RefUnwindSafe for Scope<'scope, 'env>

impl<'scope, 'env> Send for Scope<'scope, 'env>

impl<'scope, 'env> Sync for Scope<'scope, 'env>

impl<'scope, 'env> Unpin for Scope<'scope, 'env>

impl<'scope, 'env> UnsafeUnpin for Scope<'scope, 'env>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn type_id() -> TypeId

Returns the TypeId of Self. Read more

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more

fn type_hash(&self) -> u64

Returns a deterministic hash of the TypeId of Self.

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

Returns a deterministic hash of the TypeId of Self using a custom hasher.

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Available on crate feature alloc only.

Upcasts Box<self> as Box<dyn Any>. Read more

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some shared reference to the inner value if it is of type T. Read more

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout and non-crate feature safe_code only.

Returns some exclusive reference to the inner value if it is of type T. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.

const BYTE_SIZE: usize = _

The size of this type in bytes.

fn byte_align(&self) -> usize

Returns the alignment of this type in bytes.

fn byte_size(&self) -> usize

Returns the size of this type in bytes. Read more

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Hook for T

fn hook<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Hooks a mutation step into the value and returns it. Read more

fn tap<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Taps into the value for observation and returns it unchanged. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

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

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.

fn mem_align_of<T>() -> usize

Returns the minimum alignment of the type in bytes. Read more

fn mem_align_of_val(&self) -> usize

Returns the alignment of the pointed-to value in bytes. Read more

fn mem_size_of<T>() -> usize

Returns the size of a type in bytes. Read more

fn mem_size_of_val(&self) -> usize

Returns the size of the pointed-to value in bytes. Read more

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.

Returns the value of type T represented by the all-zero byte-pattern. Read more

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &[u8]. Read more

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.

View a Sync + Unpin self as &mut [u8]. Read more

impl<T, R> Morph<R> for T
where T: ?Sized,

fn morph<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Morphs the value into a new one and returns it. Read more

fn morph_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Morphs the value by shared reference and returns the result. Read more

fn morph_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Morphs the value by exclusive reference and returns the result. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> ⓘ

Performs the conversion.

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.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> ⓘ

Performs the conversion.