Struct zng_task::ipc::Worker

source ·
pub struct Worker<I: IpcValue, O: IpcValue> { /* private fields */ }
Expand description

Represents a running worker process.

Implementations§

source§

impl<I: IpcValue, O: IpcValue> Worker<I, O>

source

pub async fn start(worker_name: impl Into<Txt>) -> Result<Self>

Start a worker process implemented in the current executable.

Note that the current process must call run_worker at startup to actually work. You can use zng_env::on_process_start! to inject startup code.

source

pub async fn start_with( worker_name: impl Into<Txt>, env_vars: &[(&str, &str)], args: &[&str] ) -> Result<Self>

Start a worker process implemented in the current executable with custom env vars and args.

source

pub async fn start_other( worker_name: impl Into<Txt>, worker_exe: impl Into<PathBuf>, env_vars: &[(&str, &str)], args: &[&str] ) -> Result<Self>

Start a worker process implemented in another executable with custom env vars and args.

source

pub async fn start_duct( worker_name: impl Into<Txt>, worker: Expression ) -> Result<Self>

Start a worker process from a custom configured duct process.

Note that the worker executable must call run_worker at startup to actually work. You can use zng_env::on_process_start! to inject startup code.

source

pub async fn shutdown(self) -> Result<()>

Awaits current tasks and kills the worker process.

source

pub fn run( &mut self, input: I ) -> impl Future<Output = Result<O, RunError>> + Send + 'static

Run a task in a free worker thread.

source

pub fn crash_error(&mut self) -> Option<&WorkerCrashError>

Crash error.

The worker cannot be used if this is set, run requests will immediately disconnect.

Trait Implementations§

source§

impl<I: IpcValue, O: IpcValue> Drop for Worker<I, O>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<I, O> !Freeze for Worker<I, O>

§

impl<I, O> !RefUnwindSafe for Worker<I, O>

§

impl<I, O> Send for Worker<I, O>

§

impl<I, O> !Sync for Worker<I, O>

§

impl<I, O> Unpin for Worker<I, O>
where I: Unpin,

§

impl<I, O> !UnwindSafe for Worker<I, O>

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> 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> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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> Same for T

§

type Output = T

Should always be Self
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<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
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