pub struct OffloadEngineBuilder { /* private fields */ }Expand description
Builder for OffloadEngine.
Implementations§
Source§impl OffloadEngineBuilder
impl OffloadEngineBuilder
Sourcepub fn new(leader: Arc<InstanceLeader>) -> Self
pub fn new(leader: Arc<InstanceLeader>) -> Self
Create a new builder with the given instance leader.
Sourcepub fn with_runtime(self, runtime: Handle) -> Self
pub fn with_runtime(self, runtime: Handle) -> Self
Set an explicit runtime handle for spawning pipeline tasks.
If not set, defaults to leader.runtime(). Use this when you need
pipeline tasks to run on a specific runtime (e.g., in tests).
Sourcepub fn with_registry(self, registry: Arc<BlockRegistry>) -> Self
pub fn with_registry(self, registry: Arc<BlockRegistry>) -> Self
Set the block registry.
Sourcepub fn with_g1_manager(self, manager: Arc<BlockManager<G1>>) -> Self
pub fn with_g1_manager(self, manager: Arc<BlockManager<G1>>) -> Self
Set the G1 block manager.
Sourcepub fn with_g2_manager(self, manager: Arc<BlockManager<G2>>) -> Self
pub fn with_g2_manager(self, manager: Arc<BlockManager<G2>>) -> Self
Set the G2 block manager.
Sourcepub fn with_g3_manager(self, manager: Arc<BlockManager<G3>>) -> Self
pub fn with_g3_manager(self, manager: Arc<BlockManager<G3>>) -> Self
Set the G3 block manager.
Sourcepub fn with_object_ops(self, object_ops: Arc<dyn ObjectBlockOps>) -> Self
pub fn with_object_ops(self, object_ops: Arc<dyn ObjectBlockOps>) -> Self
Set object storage operations for G4.
G4 is object storage (S3, MinIO, etc.) and uses ObjectBlockOps
instead of a BlockManager. This replaces with_g4_manager.
Sourcepub fn with_g2_physical_layout(self, layout: PhysicalLayout) -> Self
pub fn with_g2_physical_layout(self, layout: PhysicalLayout) -> Self
Set the G2 physical layout for object transfers.
Required when using G2→G4 pipeline. The ObjectTransferExecutor needs the physical layout to read block data for upload to object storage.
Sourcepub fn with_g1_to_g2_pipeline(self, config: PipelineConfig<G1, G2>) -> Self
pub fn with_g1_to_g2_pipeline(self, config: PipelineConfig<G1, G2>) -> Self
Configure G1→G2 pipeline.
Sourcepub fn with_g2_to_g3_pipeline(self, config: PipelineConfig<G2, G3>) -> Self
pub fn with_g2_to_g3_pipeline(self, config: PipelineConfig<G2, G3>) -> Self
Configure G2→G3 pipeline.
Sourcepub fn with_g2_to_g4_pipeline(self, config: ObjectPipelineConfig<G2>) -> Self
pub fn with_g2_to_g4_pipeline(self, config: ObjectPipelineConfig<G2>) -> Self
Configure G2→G4 pipeline (object storage).
Uses ObjectPipelineConfig instead of PipelineConfig since G4
is object storage, not a BlockManager destination.
For distributed setups where the leader doesn’t have physical layouts,
use with_enable_remote_g4(true) instead.
Sourcepub fn with_enable_remote_g4(self, enable: bool) -> Self
pub fn with_enable_remote_g4(self, enable: bool) -> Self
Enable remote G4 offloading via workers’ ObjectBlockOps.
In distributed setups, the leader doesn’t have physical layouts (only workers do). This enables G2→G4 offloading where:
- G1→G2 chain output is routed to a remote offload task
- The task calls workers’ ObjectBlockOps::put_blocks() via RPC
- Workers upload blocks from their local G2 to object storage
- Per-block results are returned and logged
This is mutually exclusive with with_g2_to_g4_pipeline() - use one or the other.
Sourcepub fn build(self) -> Result<OffloadEngine>
pub fn build(self) -> Result<OffloadEngine>
Build the offload engine.
Auto Trait Implementations§
impl !RefUnwindSafe for OffloadEngineBuilder
impl !UnwindSafe for OffloadEngineBuilder
impl Freeze for OffloadEngineBuilder
impl Send for OffloadEngineBuilder
impl Sync for OffloadEngineBuilder
impl Unpin for OffloadEngineBuilder
impl UnsafeUnpin for OffloadEngineBuilder
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);