Skip to main content

RoutineClient

Struct RoutineClient 

Source
pub struct RoutineClient { /* private fields */ }
Expand description

Client for a routine daemon rooted at one machine-local state directory.

request never starts a daemon. start ensures a daemon is running without accessing a project. request_with_start accepts routine list and mutation requests, probes daemon availability with a status request, then starts the caller-provided command only when the daemon is unavailable. Status and shutdown requests are rejected by the auto-start boundary and must use request. The caller’s request is sent exactly once. Availability probing and startup share the configured startup timeout. The command must run a routine daemon that writes ready or error:<message> to the descriptor supplied in the ASCHED_STARTUP_FD environment variable. The client adds that handshake and a detached process group; executable, arguments, standard streams, and other environment are controlled by the caller.

Implementations§

Source§

impl RoutineClient

Source

pub fn new(root: PathBuf) -> Self

Source

pub fn with_startup_timeout(self, timeout: Duration) -> Self

Override the bounded startup timeout, primarily for hosts and tests.

Source

pub fn with_request_timeout(self, timeout: Duration) -> Self

Override the timeout for one request to an already-running daemon.

Source

pub fn root(&self) -> &Path

Source

pub fn socket_path(&self) -> PathBuf

Source

pub fn fire( &self, project: &Path, kind: &str, payload: Value, event_id: &str, ) -> Result<FireOutcome, RoutineError>

Source

pub fn request(&self, request: &Request) -> Result<Response, RoutineError>

Send to an already-running daemon without changing daemon lifecycle.

Source

pub fn start(&self, command: Command) -> Result<(), RoutineError>

Ensure a daemon is running without issuing a project-scoped request.

Source

pub fn request_with_start( &self, request: &Request, command: Command, ) -> Result<Response, RoutineError>

Send a request once, starting the daemon with command if it is unavailable.

Trait Implementations§

Source§

impl Clone for RoutineClient

Source§

fn clone(&self) -> RoutineClient

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 RoutineClient

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