pub struct OffloadEngine { /* private fields */ }Expand description
Central coordinator for offload pipelines.
The engine manages multiple pipelines (G1→G2, G2→G3, G2→G4) and provides a unified interface for enqueueing blocks for offload.
§Storage Tier Model
- G1→G2:
BlockManager<G2>destination (host memory) - G2→G3:
BlockManager<G3>destination (disk/NVMe) - G2→G4: ObjectBlockOps destination (object storage like S3)
§Distributed G2→G4 Offloading
For distributed setups where the leader doesn’t have physical layouts (only workers do),
use with_enable_remote_g4(true) instead of with_g2_to_g4_pipeline(). This enables
remote G4 offloading where workers execute object storage uploads via their local
ObjectBlockOps implementations.
Implementations§
Source§impl OffloadEngine
impl OffloadEngine
Sourcepub fn builder(leader: Arc<InstanceLeader>) -> OffloadEngineBuilder
pub fn builder(leader: Arc<InstanceLeader>) -> OffloadEngineBuilder
Create a new builder for the offload engine.
Sourcepub fn enqueue_g1_to_g2(
&self,
blocks: impl Into<SourceBlocks<G1>>,
) -> Result<TransferHandle>
pub fn enqueue_g1_to_g2( &self, blocks: impl Into<SourceBlocks<G1>>, ) -> Result<TransferHandle>
Enqueue blocks for G1→G2 offload.
Returns a TransferHandle for tracking progress and cancellation.
Sourcepub fn enqueue_g1_to_g2_with_precondition(
&self,
blocks: impl Into<SourceBlocks<G1>>,
precondition: Option<EventHandle>,
) -> Result<TransferHandle>
pub fn enqueue_g1_to_g2_with_precondition( &self, blocks: impl Into<SourceBlocks<G1>>, precondition: Option<EventHandle>, ) -> Result<TransferHandle>
Enqueue blocks for G1→G2 offload with a precondition event.
The precondition event must be satisfied before the batch is processed by the transfer executor. This enables coordination with worker forward passes.
Returns a TransferHandle for tracking progress and cancellation.
Sourcepub fn enqueue_g2_to_g3(
&self,
blocks: impl Into<SourceBlocks<G2>>,
) -> Result<TransferHandle>
pub fn enqueue_g2_to_g3( &self, blocks: impl Into<SourceBlocks<G2>>, ) -> Result<TransferHandle>
Enqueue blocks for G2→G3 offload.
Returns a TransferHandle for tracking progress and cancellation.
Sourcepub fn enqueue_g2_to_g4(
&self,
blocks: impl Into<SourceBlocks<G2>>,
) -> Result<TransferHandle>
pub fn enqueue_g2_to_g4( &self, blocks: impl Into<SourceBlocks<G2>>, ) -> Result<TransferHandle>
Enqueue blocks for G2→G4 offload (object storage).
Returns a TransferHandle for tracking progress and cancellation.
Sourcepub fn release_transfer(&self, transfer_id: TransferId)
pub fn release_transfer(&self, transfer_id: TransferId)
Release a completed transfer’s resources.
This is optional - transfers are automatically cleaned up, but call this to release resources earlier.
Sourcepub fn active_transfer_count(&self) -> usize
pub fn active_transfer_count(&self) -> usize
Get the number of active transfers.
Sourcepub fn has_g1_to_g2(&self) -> bool
pub fn has_g1_to_g2(&self) -> bool
Check if G1→G2 pipeline is configured.
Sourcepub fn has_g2_to_g3(&self) -> bool
pub fn has_g2_to_g3(&self) -> bool
Check if G2→G3 pipeline is configured.
Sourcepub fn has_g2_to_g4(&self) -> bool
pub fn has_g2_to_g4(&self) -> bool
Check if G2→G4 pipeline is configured.
Sourcepub fn settlement_token(&self) -> SettlementToken
pub fn settlement_token(&self) -> SettlementToken
Capture a causal checkpoint for every configured transfer lane.
Sourcepub async fn settle_after(
&self,
token: SettlementToken,
target: SettlementTarget,
) -> Result<(), SettlementError>
pub async fn settle_after( &self, token: SettlementToken, target: SettlementTarget, ) -> Result<(), SettlementError>
Wait until the targeted post-token batches are causally settled.
Settlement includes synchronous executor publication and semaphore handoff to every immediately runnable successor. It deliberately does not include auto-chained downstream topology in this implementation slice.
Auto Trait Implementations§
impl !RefUnwindSafe for OffloadEngine
impl !UnwindSafe for OffloadEngine
impl Freeze for OffloadEngine
impl Send for OffloadEngine
impl Sync for OffloadEngine
impl Unpin for OffloadEngine
impl UnsafeUnpin for OffloadEngine
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::RequestSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);