Struct vfs::execution_scope::ExecutionScope

source ·
pub struct ExecutionScope { /* private fields */ }
Expand description

An execution scope that is hosting tasks for a group of connections. See the module level documentation for details.

Actual execution will be delegated to an “upstream” executor - something that implements [futures::task::Spawn]. In a sense, this is somewhat of an analog of a multithreaded capable [futures::stream::FuturesUnordered], but this some additional functionality specific to the vfs library.

Use ExecutionScope::new() or ExecutionScope::build() to construct new ExecutionScopees.

Implementations§

source§

impl ExecutionScope

source

pub fn new() -> Self

Constructs an execution scope. Use ExecutionScope::build() if you want to specify parameters.

source

pub fn build() -> ExecutionScopeParams

Constructs a new execution scope builder, wrapping the specified executor and optionally accepting additional parameters. Run ExecutionScopeParams::new() to get an actual ExecutionScope object.

source

pub fn active_count(&self) -> usize

Returns the active count: the number of tasks that are active and will prevent shutdown.

source

pub fn spawn( &self, task: impl Future<Output = ()> + Send + 'static, ) -> JoinHandle<()>

Sends a task to be executed in this execution scope. This is very similar to [futures::task::Spawn::spawn_obj()] with a minor difference that self reference is not exclusive.

If the task needs to prevent itself from being shutdown, then it should use the try_active_guard function below.

For the “vfs” library it is more convenient that this method allows non-exclusive access. And as the implementation is employing internal mutability there are no downsides. This way ExecutionScope can actually also implement [futures::task::Spawn] - it just was not necessary for now.

source

pub fn token_registry(&self) -> &TokenRegistry

source

pub fn shutdown(&self)

source

pub fn force_shutdown(&self)

Forcibly shut down the executor without respecting the active guards.

source

pub fn resurrect(&self)

Restores the executor so that it is no longer in the shut-down state. Any tasks that are still running will continue to run after calling this.

source

pub async fn wait(&self)

Wait for all tasks to complete.

source

pub fn try_active_guard(&self) -> Option<ActiveGuard>

Prevents the executor from shutting down whilst the guard is held. Returns None if the executor is shutting down.

source

pub fn active_guard(&self) -> ActiveGuard

As above, but succeeds even if the executor is shutting down. This can be used in drop implementations to spawn tasks that must run before the executor shuts down.

Trait Implementations§

source§

impl Clone for ExecutionScope

source§

fn clone(&self) -> ExecutionScope

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ExecutionScope

source§

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

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

impl PartialEq for ExecutionScope

source§

fn eq(&self, other: &Self) -> 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 Eq for ExecutionScope

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoAny for T
where T: 'static + Send + Sync,

source§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Cast the given object into a dyn std::any::Any.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more