pub struct ObjectLockPresenceFilter<Src: BlockMetadata> { /* private fields */ }Expand description
G2→G4 filter with distributed locking: check meta, acquire lock, track acquired locks.
This filter implements the full locking protocol for object storage offloads:
- Check if
.metafile exists (block already offloaded) - skip if yes - Check if currently pending (in-flight transfer) - skip if yes
- Try to acquire
.lockfile with conditional PUT- If lock doesn’t exist, create it atomically
- If lock exists and expired, overwrite it
- If lock exists and valid (owned by another instance), skip
- If we own the lock (either just acquired or already owned), pass the block
§Lock Management
Locks acquired during policy evaluation are tracked and must be:
- Released after successful transfer (via
ObjectTransferExecutor) - Released on error/cancellation (via guard or explicit cleanup)
§Duplicate Prevention
When a PendingTracker is configured, blocks currently in-flight are filtered
out before checking object storage, avoiding redundant network calls.
§Example
let lock_manager = Arc::new(S3LockManager::new(s3_client, instance_id));
let tracker = Arc::new(PendingTracker::new());
let filter = ObjectLockPresenceFilter::<G2>::new(lock_manager)
.with_pending_tracker(tracker);
// Blocks already offloaded, in-flight, or locked by others will be filtered outImplementations§
Source§impl<Src: BlockMetadata> ObjectLockPresenceFilter<Src>
impl<Src: BlockMetadata> ObjectLockPresenceFilter<Src>
Sourcepub fn new(lock_manager: Arc<dyn ObjectLockManager>) -> Self
pub fn new(lock_manager: Arc<dyn ObjectLockManager>) -> Self
Create a new object lock presence filter.
Sourcepub fn with_pending_tracker(self, tracker: Arc<PendingTracker>) -> Self
pub fn with_pending_tracker(self, tracker: Arc<PendingTracker>) -> Self
Add a pending tracker for duplicate prevention.
When set, blocks that are currently in-flight (passed policy but not yet stored in object storage) will be filtered out.
Sourcepub fn pending_tracker(&self) -> Option<&Arc<PendingTracker>>
pub fn pending_tracker(&self) -> Option<&Arc<PendingTracker>>
Get a reference to the pending tracker if configured.
Sourcepub fn lock_manager(&self) -> &Arc<dyn ObjectLockManager> ⓘ
pub fn lock_manager(&self) -> &Arc<dyn ObjectLockManager> ⓘ
Get a reference to the lock manager.
Trait Implementations§
Source§impl<Src: BlockMetadata> OffloadPolicy<Src> for ObjectLockPresenceFilter<Src>
impl<Src: BlockMetadata> OffloadPolicy<Src> for ObjectLockPresenceFilter<Src>
Source§fn evaluate<'a>(&'a self, ctx: &'a EvalContext<Src>) -> PolicyFuture<'a>
fn evaluate<'a>(&'a self, ctx: &'a EvalContext<Src>) -> PolicyFuture<'a>
Source§fn evaluate_batch<'a>(
&'a self,
contexts: &'a [EvalContext<Src>],
) -> PolicyBatchFuture<'a>
fn evaluate_batch<'a>( &'a self, contexts: &'a [EvalContext<Src>], ) -> PolicyBatchFuture<'a>
Auto Trait Implementations§
impl<Src> !RefUnwindSafe for ObjectLockPresenceFilter<Src>
impl<Src> !UnwindSafe for ObjectLockPresenceFilter<Src>
impl<Src> Freeze for ObjectLockPresenceFilter<Src>
impl<Src> Send for ObjectLockPresenceFilter<Src>
impl<Src> Sync for ObjectLockPresenceFilter<Src>
impl<Src> Unpin for ObjectLockPresenceFilter<Src>where
Src: Unpin,
impl<Src> UnsafeUnpin for ObjectLockPresenceFilter<Src>
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);