Skip to main content

ImmutableBlock

Struct ImmutableBlock 

Source
pub struct ImmutableBlock<T: BlockMetadata> { /* private fields */ }
Expand description

RAII guard for a block in the Registered state.

Clone increments an Arc and the inflight_immutable metric; dropping a clone decrements the metric. Dropping the last strong reference triggers the slot’s transition to Inactive (primary) or Reset (duplicate).

Implementations§

Source§

impl<T: BlockMetadata + Sync> ImmutableBlock<T>

Source

pub fn downgrade(&self) -> WeakBlock<T>

Creates a WeakBlock that does not prevent the block from being evicted.

Source

pub fn block_id(&self) -> BlockId

Returns the BlockId assigned to this block.

Source

pub fn sequence_hash(&self) -> SequenceHash

Returns the SequenceHash that identifies this block’s content.

Source

pub fn registration_handle(&self) -> BlockRegistrationHandle

Returns a clone of the BlockRegistrationHandle for this block.

Source

pub fn use_count(&self) -> usize

Returns the number of strong Arc references to the underlying inner.

Source

pub fn set_evict_on_reset(&self, value: bool)

Set the per-block “reset on release” override.

When the last clone of this block drops, the slot transitions to the reset/free list (true) or to the inactive cache (false), overriding the store-wide default set by BlockManagerConfigBuilder::with_default_reset_on_release.

The override is sticky across cache-hit resurrections: if the block lands in the inactive pool and is later matched, the resurrected ImmutableBlock inherits this value. The override is reset to the store-wide default only when the slot truly leaves the inactive pool (eviction back to Mutable).

Briefly acquires the store mutex to publish the write. Not a hot path — typically called at most once per block. Concurrent setters race with last-writer-wins semantics under the mutex.

Race-window guarantee: the override is preserved even when a concurrent match_blocks drives the eager Primary → Inactive transition (because this Inner’s Arc strong-count went to 0 before release_primary ran). The eager path leaves the per-slot value untouched, and every reader of that value also goes through the same store mutex — so visibility comes from release-acquire on the mutex, not from any assumption about Arc::drop / Weak::upgrade ordering.

Source

pub fn pin(&self) -> LifecyclePinRef

Type-erased lifecycle pin for cross-policy use.

Returns an LifecyclePinRef that:

  • Bumps the underlying Arc<ImmutableBlockInner<T>> once (the only allocation cost is one Arc::clone — no Box and no new heap node).
  • Keeps the slot alive (preventing the Active → Inactive transition) while the pin is live, identical to holding an ImmutableBlock clone.
  • Exposes (manager_id, block_id, sequence_hash) so callers that stash a heterogeneous list of pins (different Ts) can still address each slot unambiguously at runtime.

See [crate::blocks::pin] for the rationale.

Trait Implementations§

Source§

impl<T: BlockMetadata + Sync> Clone for ImmutableBlock<T>

Source§

fn clone(&self) -> Self

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<T: BlockMetadata> Debug for ImmutableBlock<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: BlockMetadata> Drop for ImmutableBlock<T>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for ImmutableBlock<T>

§

impl<T> !UnwindSafe for ImmutableBlock<T>

§

impl<T> Freeze for ImmutableBlock<T>

§

impl<T> Send for ImmutableBlock<T>

§

impl<T> Sync for ImmutableBlock<T>

§

impl<T> Unpin for ImmutableBlock<T>

§

impl<T> UnsafeUnpin for ImmutableBlock<T>

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> BlockMetadata for T
where T: Clone + Send + Sync + 'static,

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