Skip to main content

StepRequest

Struct StepRequest 

Source
pub struct StepRequest {
    pub inputs: Vec<Artifact>,
    pub output_dir: PathBuf,
    pub from: String,
    pub to: String,
    pub operation: String,
    pub limits: Limits,
    pub params: BTreeMap<String, String>,
    pub spent_output_bytes: u64,
}
Expand description

One adapter invocation. Adapters must write only inside output_dir, must not change inputs, and must return at least one regular file on success.

The engine creates the output directory before calling the adapter. The adapter is responsible for validating operation-specific inputs, observing limits, and keeping blocking work off the asynchronous executor. The engine checks returned files but does not enforce every part of this contract; in particular, it currently accepts an empty output vector.

Fields§

§inputs: Vec<Artifact>

Ordered staged inputs or outputs from the preceding step; do not mutate them.

§output_dir: PathBuf

Existing private step directory where the adapter must create outputs.

§from: String

Concrete source format ID, not a filename extension or wildcard.

§to: String

Concrete target format ID that every returned artifact must declare.

§operation: String

Adapter-specific operation ID copied from the selected conversion edge.

§limits: Limits

Resource budgets for this invocation; see Limits for enforcement scope.

§params: BTreeMap<String, String>

Quality knobs copied from ConversionOptions::params.

Keys are adapter-defined names such as quality; the reserved key quality carries a 0-100 integer string and should be mapped onto the closest native encoder control. Adapters must ignore unknown keys and must never treat these values as paths or shell input.

§spent_output_bytes: u64

Cumulative bytes the engine has already validated across earlier steps of the current route, used with Limits::max_total_output_bytes.

Implementations§

Source§

impl StepRequest

Source

pub fn new( inputs: Vec<Artifact>, output_dir: impl Into<PathBuf>, from: impl Into<String>, to: impl Into<String>, operation: impl Into<String>, limits: Limits, ) -> Self

Build a request with no params and no prior output spend.

Source

pub fn with_params(self, params: &BTreeMap<String, String>) -> Self

Attach quality params; see Self::params.

Source

pub fn with_spent_output_bytes(self, spent: u64) -> Self

Record cumulative earlier-step output bytes; see Self::spent_output_bytes.

Trait Implementations§

Source§

impl Clone for StepRequest

Source§

fn clone(&self) -> Self

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 StepRequest

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.