Skip to main content

MutableBlock

Struct MutableBlock 

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

RAII guard for a block in the Reset state.

Wraps an internal Block<T, Reset> and guarantees that the block is returned to the reset pool when the guard is dropped – whether the caller explicitly transitions it or simply lets it fall out of scope.

§Obtaining a MutableBlock

§State transitions

Both methods consume self and return the block inside Err(BlockError) on size mismatch so it is never leaked.

§Drop behaviour

Dropping a MutableBlock returns the underlying block to the reset pool and decrements the inflight_mutable metric gauge.

Implementations§

Source§

impl<T: BlockMetadata> MutableBlock<T>

Source

pub fn block_id(&self) -> BlockId

Returns the BlockId assigned to this block.

Source

pub fn stage( self, seq_hash: SequenceHash, block_size: usize, ) -> Result<CompleteBlock<T>, BlockError<MutableBlock<T>>>

Transitions from Reset to Staged, producing a CompleteBlock.

The caller supplies a pre-computed SequenceHash and the expected block_size. If block_size does not match the block’s fixed size the method returns Err(BlockError::BlockSizeMismatch) with the MutableBlock inside so the caller can recover it.

Increments the stagings counter on success.

Source

pub fn complete( self, token_block: &TokenBlock, ) -> Result<CompleteBlock<T>, BlockError<MutableBlock<T>>>

Transitions from Reset to Staged, producing a CompleteBlock.

The SequenceHash is derived from the provided TokenBlock. If the token block’s size does not match the block’s fixed size the method returns Err(BlockError::BlockSizeMismatch) with the MutableBlock inside so the caller can recover it.

Increments the stagings counter on success.

Trait Implementations§

Source§

impl<T: BlockMetadata> Debug for MutableBlock<T>

Source§

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

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

impl<T: BlockMetadata> Drop for MutableBlock<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 MutableBlock<T>

§

impl<T> !UnwindSafe for MutableBlock<T>

§

impl<T> Freeze for MutableBlock<T>

§

impl<T> Send for MutableBlock<T>

§

impl<T> Sync for MutableBlock<T>

§

impl<T> Unpin for MutableBlock<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for MutableBlock<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> 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> 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, 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