Struct RunClient 

pub struct RunClient { /* private fields */ }

Client for a specific Actor run.

In addition to CRUD-style operations, this client exposes the run’s lifecycle actions (abort, metamorph, reboot, resurrect, charge) and provides access to the run’s default dataset, key-value store, request queue and log.

Implementations

impl RunClient

pub async fn get(&self) -> ApifyClientResult<Option<ActorRun>>

Fetches the run object, or None if it does not exist.

pub async fn update<T: Serialize>( &self, new_fields: &T, ) -> ApifyClientResult<ActorRun>

Updates the run (e.g. its status message) and returns the updated object.

pub async fn delete(&self) -> ApifyClientResult<()>

Deletes the run.

pub async fn abort( &self, gracefully: Option<bool>, ) -> ApifyClientResult<ActorRun>

Aborts the run. gracefully is optional, matching the reference client’s optional gracefully option and the Go sibling’s Option<bool>: Some(true) lets the run perform cleanup first, Some(false) aborts immediately, and None omits the parameter entirely so the server applies its default (immediate abort).

pub async fn metamorph<T: Serialize>( &self, target_actor_id: &str, input: Option<&T>, options: RunMetamorphOptions, ) -> ApifyClientResult<ActorRun>

Transforms the run into a run of another Actor (metamorph).

options.content_type sets the content type of the input body (defaulting to application/json), matching the reference client’s metamorph(..., { contentType }).

pub async fn reboot(&self) -> ApifyClientResult<ActorRun>

Reboots the run (restarts its container, preserving the run ID and storages).

pub async fn resurrect( &self, options: RunResurrectOptions, ) -> ApifyClientResult<ActorRun>

Resurrects a finished run, starting it again with (optionally overridden) settings.

pub async fn charge(&self, options: RunChargeOptions) -> ApifyClientResult<()>

Charges the run for a pay-per-event run, recording occurrences of a named event.

An idempotency key is always sent (auto-generated when options.idempotency_key is None), so a charge that is retried by the transport is applied at most once — matching the reference client and preventing double-charging.

The charge endpoint returns an empty body on success, so this issues the request directly and treats any 2xx response as success (errors still surface normally).

pub async fn wait_for_finish( &self, wait_secs: Option<i64>, ) -> ApifyClientResult<ActorRun>

Waits (by client-side polling) for the run to reach a terminal state.

wait_secs controls the wait budget:

• None polls indefinitely until the run reaches a terminal state.
• Some(n) bounds the wait to roughly n seconds; if the run has not finished by then, the last fetched (still non-terminal) run is returned rather than an error. Check status / is_terminal() on the result when using Some.

pub fn dataset(&self) -> DatasetClient

Returns a client for the run’s default dataset.

pub fn key_value_store(&self) -> KeyValueStoreClient

Returns a client for the run’s default key-value store.

pub fn request_queue(&self) -> RequestQueueClient

Returns a client for the run’s default request queue.

pub fn log(&self) -> LogClient

Returns a client for the run’s log.

pub async fn get_streamed_log( &self, ) -> ApifyClientResult<impl Stream<Item = ApifyClientResult<Vec<u8>>>>

Opens a live stream of the run’s log for redirection.

Convenience equivalent to run.log().stream() (mirrors the reference client’s getStreamedLog): yields log chunks as they arrive, so callers can forward them to their own logger/stdout while the run is in progress.

pub async fn get_streamed_log_with_options( &self, options: LogOptions, ) -> ApifyClientResult<impl Stream<Item = ApifyClientResult<Vec<u8>>>>

Opens a live stream of the run’s log for redirection, applying the given [LogOptions] (e.g. [LogOptions::raw] to stream the unprocessed log, which is the form the JS reference’s log redirection consumes internally).

This is a Rust-specific convenience that simply forwards LogOptions to LogClient::stream_with_options; it is not a 1:1 mirror of the JS getStreamedLog method’s signature (which takes redirect options and returns a StreamedLog object).

Trait Implementations

impl Clone for RunClient

fn clone(&self) -> RunClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunClient

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

Formats the value using the given formatter.