Skip to main content

MapSpec

Struct MapSpec 

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

A map operation.

use ytsaurus_client::MapSpec;

let spec = MapSpec::new("./cat", ["//tmp/in"], ["//tmp/out"])
    .with_local_file("//tmp/cat")
    .with_memory_limit(512 * 1024 * 1024);

Implementations§

Source§

impl MapSpec

Source

pub fn new<I, O>(command: impl Into<String>, inputs: I, outputs: O) -> Self

A map running command over inputs, writing outputs.

Source

pub fn with_local_file(self, path: impl Into<String>) -> Self

Adds a Cypress file the job needs — normally the worker binary.

Source

pub fn with_local_file_named( self, path: impl Into<String>, name: impl AsRef<str>, ) -> Self

Adds a Cypress file under a different name in the job’s sandbox.

The name matters because the job runs a command: a file cached under its MD5 hash arrives as 4c8f…, and ./my_job would not find it.

Source

pub fn with_memory_limit(self, bytes: i64) -> Self

Sets the mapper’s memory limit, in bytes.

Source

pub fn with_formats(self, input: DataFormat, output: DataFormat) -> Self

Selects the mapper’s input and output data formats.

YSON selections apply to every table. A Skiff selection must contain one table schema per corresponding input or output table, in the same order. The default remains binary YSON.

Source

pub fn with_skiff_formats(self, input: SkiffFormat, output: SkiffFormat) -> Self

Uses validated Skiff formats for the mapper’s input and output streams.

This compatibility convenience delegates to Self::with_formats.

Source

pub fn with_env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Sets an environment variable for the job, e.g. RUST_BACKTRACE.

Source

pub fn with_input_table_index(self) -> Self

Asks for the input table index to be delivered with each row.

Without this, Row::table_index is always 0.

Source

pub fn with_job_count(self, count: i64) -> Self

Requests a specific job count.

Source

pub fn skiff_table_mismatch(&self) -> Option<String>

Describes a Skiff format that does not match this spec’s table lists.

A Skiff format needs one table schema per table, in order. Get the count wrong and the operation is submitted anyway: the cluster may refuse it, or the job may read a table the format does not describe and fail mid-stream, after it has already written output. Client::start_map checks this before sending the spec; check it here if you render the spec yourself with MapSpec::to_yson.

Source

pub fn with_raw(self, key: impl Into<String>, value: YsonValue) -> Self

Sets any spec field this builder does not model.

Source

pub fn to_yson(&self) -> YsonValue

Renders the spec.

Trait Implementations§

Source§

impl Clone for MapSpec

Source§

fn clone(&self) -> MapSpec

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 MapSpec

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