Skip to main content

ExternalTransform

Struct ExternalTransform 

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

External (child-stdio) transform stage.

surreal-sync spawns the configured worker and talks on the worker’s stdin/stdout pipes — not the surreal-sync CLI’s stdin.

Exchanges are multiplexed by batch_id: ExternalTransport::write_request / ExternalTransport::try_read_response support overlapping in-flight batches (max_in_flight > 1). Each waiter reads only its own request’s response (request-keyed); payloads are never rebound onto another outstanding id. A mismatched echo fails the exchange (no sink / watermark advance).

§Relations

Relation batches use the same NDJSON framing with WireItemKind::RelationChange / WireItemKind::Relation. There is no silent pass-through of relation events past External stages.

Implementations§

Source§

impl ExternalTransform

Source

pub fn with_transport(transport: Arc<dyn ExternalTransport>) -> Self

Build an external stage over an arbitrary multiplexed transport.

Source

pub fn with_timeout(self, timeout: Option<Duration>) -> Self

Set per-exchange timeout for this stage (None clears it).

Intended as a builder step at construction time (before the stage is shared across in-flight batches).

Source

pub fn with_retry(self, retry: RetryPolicy) -> Self

Set per-stage retry/backoff policy.

Intended as a builder step at construction time.

Source

pub fn persistent_child( command: Vec<String>, framer: FramerKind, ) -> Result<Self>

Spawn a persistent child worker (default mode): one process, many batches.

Source

pub fn transient_child(command: Vec<String>, framer: FramerKind) -> Result<Self>

Transient child worker: spawn → one exchange → exit, per batch.

Source

pub fn child_stdio( mode: ChildStdioMode, command: Vec<String>, framer: FramerKind, ) -> Result<Self>

Convenience from mode + argv + framer.

Source

pub fn command_from_bin(bin: impl Into<PathBuf>, args: &[&str]) -> Vec<String>

Path helper for tests locating a fixture binary.

Source

pub async fn exchange_changes( &self, batch_id: u64, changes: Vec<Change>, ) -> Result<Vec<Change>>

Exchange a change batch with the worker (serialize → I/O → deserialize).

Source

pub async fn exchange_rows( &self, batch_id: u64, rows: Vec<Row>, ) -> Result<Vec<Row>>

Exchange a row batch with the worker.

Source

pub async fn exchange_relation_changes( &self, batch_id: u64, changes: Vec<RelationChange>, ) -> Result<Vec<RelationChange>>

Exchange a relation-change batch with the worker (NDJSON wire).

Source

pub async fn exchange_relations( &self, batch_id: u64, relations: Vec<Relation>, ) -> Result<Vec<Relation>>

Exchange a full-sync relation batch with the worker.

Trait Implementations§

Source§

impl Clone for ExternalTransform

Source§

fn clone(&self) -> ExternalTransform

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 ExternalTransform

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> 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> 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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