pub struct ToolLane { /* private fields */ }Expand description
The tool lane: the capacity that bounds how many batches execute at once, and the plumbing a batch needs to report its outcome.
Implementations§
Source§impl ToolLane
impl ToolLane
Sourcepub fn new(
runtime: Handle,
results: UnboundedSender<ToolOutcome>,
wake: Arc<Notify>,
concurrency: usize,
stats: Arc<ToolLaneStats>,
) -> Arc<Self> ⓘ
pub fn new( runtime: Handle, results: UnboundedSender<ToolOutcome>, wake: Arc<Notify>, concurrency: usize, stats: Arc<ToolLaneStats>, ) -> Arc<Self> ⓘ
Build a lane that runs concurrency batches at a time (clamped to at
least one, matching ToolLaneStats::new).
Sourcepub fn serve(
self: &Arc<Self>,
jobs: UnboundedReceiver<ToolJob>,
) -> JoinHandle<()> ⓘ
pub fn serve( self: &Arc<Self>, jobs: UnboundedReceiver<ToolJob>, ) -> JoinHandle<()> ⓘ
Start serving jobs. The returned handle completes once the job channel
closes (the world is shutting down) and every batch it started has
finished, so awaiting it drains the lane.
Sourcepub fn relieve(&self, extra: usize) -> usize
pub fn relieve(&self, extra: usize) -> usize
Add extra permits, widening the lane.
The relief valve under a lane that has stopped draining: handing out more
capacity lets the queued batches run without cancelling anything. Returns
how many were added. No longer “for good”: once the jam is over,
Self::narrow hands the extra capacity back, so a single historical
wedge does not raise the daemon’s peak concurrency (and with it, peak
memory) for the rest of its life.
Sourcepub fn narrow(&self, upto: usize) -> usize
pub fn narrow(&self, upto: usize) -> usize
Take up to upto idle permits back out of the lane, returning how many
were reclaimed.
forget_permits only removes permits that are currently available, so
this can never stall a batch that is running or block waiting for one to
finish - a busy lane just gives back fewer (possibly zero) permits, and
the caller tries again on a later healthy cycle.
Auto Trait Implementations§
impl !RefUnwindSafe for ToolLane
impl !UnwindSafe for ToolLane
impl Freeze for ToolLane
impl Send for ToolLane
impl Sync for ToolLane
impl Unpin for ToolLane
impl UnsafeUnpin for ToolLane
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.