Skip to main content

SpawnSpec

Struct SpawnSpec 

Source
pub struct SpawnSpec {
    pub binary: PathBuf,
    pub args: Vec<String>,
    pub env: Vec<(String, String)>,
    pub deadline: Duration,
    pub drain_grace: Duration,
}

Fields§

§binary: PathBuf§args: Vec<String>§env: Vec<(String, String)>

Extra env vars to pass to the child (in addition to the handoff envelope).

§deadline: Duration

Absolute wall-clock cap on the entire handoff, from perform_handoff start through Commit send. Sized to comfortably exceed the consumer’s Drainable::drain + Drainable::seal p99 under load — the library does not interrupt long-but-progressing hooks (heartbeats from the incumbent keep the supervisor’s liveness clock fresh), but it will abort once this wall-clock cap is exceeded regardless of progress.

The supervisor’s reads for SealComplete and Ready extend up to WIRE_SLACK (1 s) past this cap to pick up replies that were already on the wire when the deadline elapsed; total wall time can therefore exceed deadline by up to that slack.

Tuning guidance: set this to p99(drain) + p99(seal) + 30s. Default: 5 minutes.

§drain_grace: Duration

Wall-clock cap on the drain phase specifically. Useful when the consumer’s drain has a known upper bound (e.g. drain timeout configured per-connection) and a tighter cap is wanted than the overall deadline. The supervisor’s read for Drained extends up to WIRE_SLACK (1 s) past this cap to pick up an in-flight reply. Default: 60 seconds.

Implementations§

Source§

impl SpawnSpec

Source

pub fn new(binary: impl Into<PathBuf>) -> Self

Build a spec for binary with the recommended defaults: 5 minute overall deadline, 60 second drain_grace, empty args and env. Mutate the returned value or build the struct directly when you need non-default fields. binary is required because the library has no useful fallback — accepting a default of PathBuf::new() would just fail at Command::spawn later with a confusing OS error.

Trait Implementations§

Source§

impl Clone for SpawnSpec

Source§

fn clone(&self) -> SpawnSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpawnSpec

Source§

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

Formats the value using the given formatter. Read more

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

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>,

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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