Skip to main content

CanonicalInMemoryStateWriter

Struct CanonicalInMemoryStateWriter 

Source
pub struct CanonicalInMemoryStateWriter<N: NodePrimitives = EthPrimitives> { /* private fields */ }
Expand description

Creates a CanonicalInMemoryState and changes it: the blocks it tracks, its chain info, and the notifications it sends.

A writer is created together with its state. Self::canonical_in_memory_state returns that state, which can be cloned and is what everything but the owner of the writer reads. What is written through the writer is read through the state and every clone of it.

A writer cannot be cloned and its methods take &mut self, so only its owner changes the state through it. The constructors of CanonicalInMemoryState and its methods that change it are still public.

Implementations§

Source§

impl<N: NodePrimitives> CanonicalInMemoryStateWriter<N>

Source

pub fn new( chain_info_headers: ChainInfoHeaders<N::BlockHeader>, in_memory_state: InMemoryState<N>, ) -> Self

Creates a canonical state over the blocks of in_memory_state, with the canonical head and the safe and finalized blocks of chain_info_headers, and returns its writer.

The blocks are shared with every other handle of in_memory_state. The chain info and the notifications belong to the created state and its clones.

Source

pub const fn canonical_in_memory_state(&self) -> &CanonicalInMemoryState<N>

Returns the state this changes.

Source

pub fn clear_state(&mut self)

Source

pub fn insert_executed(&mut self, block: ExecutedBlock<N>)

Source

pub fn set_pending_block(&mut self, pending: ExecutedBlock<N>)

Source

pub fn update_chain(&mut self, new_chain: NewCanonicalChain<N>)

Source

pub fn on_backfill_finished( &mut self, last_persisted_hash: B256, backfill_block: BlockNumHash, )

Source

pub fn on_blocks_persisted( &mut self, last_persisted_block: BlockNumHash, state_trie_persisted_block: BlockNumHash, finalized: Option<BlockNumHash>, )

Source

pub fn on_forkchoice_update_received(&mut self)

Source

pub fn set_canonical_head(&mut self, header: SealedHeader<N::BlockHeader>)

Source

pub fn set_safe(&mut self, header: SealedHeader<N::BlockHeader>)

Source

pub fn set_finalized(&mut self, header: SealedHeader<N::BlockHeader>)

Source

pub fn notify_canon_state(&mut self, event: CanonStateNotification<N>)

Trait Implementations§

Source§

impl<N: Debug + NodePrimitives> Debug for CanonicalInMemoryStateWriter<N>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
§

impl<T> MaybeDebug for T
where T: Debug,

§

impl<T> NonStaticAny for T
where T: ?Sized,

§

fn type_id(&self) -> TypeId

Returns the lifetime-erased type ID of self.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes