# Struct std::thread::Scope

1.63.0 · source ·

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

Expand description

A scope to spawn scoped threads in.

See `scope` for details.

## Implementations§

source§

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

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 the 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 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 call will create a thread using default parameters of `Builder`. If you want to specify the stack size or the name of the thread, use `Builder::spawn_scoped` instead.

##### Panics

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

## Trait Implementations§

source§

### impl Debug for Scope<'_, '_>

source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### 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> !UnwindSafe for Scope<'scope, 'env>

## 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.