Skip to main content

NextjsBootstrapState

Struct NextjsBootstrapState 

Source
pub struct NextjsBootstrapState { /* private fields */ }
Expand description

Next.js client bootstrap state machine.

This tracks hydration-safe runtime initialization with explicit phase transitions, deterministic history, and idempotent re-entry behavior.

Implementations§

Source§

impl NextjsBootstrapState

Source

pub fn new() -> Self

Creates a new bootstrap state at ServerRendered.

Source

pub fn phase(&self) -> NextjsBootstrapPhase

Returns current bootstrap phase.

Source

pub fn hydration_cycle_count(&self) -> u32

Returns number of hydration cycles observed.

Source

pub fn runtime_generation(&self) -> u32

Returns runtime generation counter.

This increments every time bootstrap reaches RuntimeReady.

Source

pub fn navigation_count(&self) -> u32

Returns number of navigation events processed.

Source

pub fn hot_reload_count(&self) -> u32

Returns number of hot-reload events processed.

Source

pub fn last_failure(&self) -> Option<&str>

Returns last runtime initialization failure reason, if any.

Source

pub fn transition_log(&self) -> &[NextjsBootstrapTransitionRecord]

Returns deterministic transition history.

Source

pub fn start_hydration( &mut self, ) -> Result<bool, NextjsBootstrapTransitionError>

Starts hydration.

This is idempotent when already in Hydrating.

Source

pub fn complete_hydration( &mut self, ) -> Result<bool, NextjsBootstrapTransitionError>

Completes hydration.

This is idempotent when already in Hydrated.

Source

pub fn mark_runtime_ready( &mut self, ) -> Result<bool, NextjsBootstrapTransitionError>

Marks runtime initialization success.

This is idempotent when already in RuntimeReady.

Source

pub fn mark_runtime_failed( &mut self, reason: impl Into<String>, ) -> Result<bool, NextjsBootstrapTransitionError>

Marks runtime initialization failure with a deterministic reason.

Source

pub fn mark_runtime_cancelled( &mut self, reason: impl Into<String>, ) -> Result<bool, NextjsBootstrapTransitionError>

Marks runtime initialization cancellation with a deterministic reason.

Source

pub fn retry_after_failure( &mut self, ) -> Result<bool, NextjsBootstrapTransitionError>

Retries bootstrap after a previous runtime failure.

Source

pub fn on_navigation( &mut self, navigation: NextjsNavigationType, ) -> Result<bool, NextjsBootstrapTransitionError>

Applies a navigation event to bootstrap state.

Soft navigations preserve runtime state. Hard and popstate navigations reset to ServerRendered.

Source

pub fn on_hot_reload(&mut self) -> Result<bool, NextjsBootstrapTransitionError>

Applies a hot-reload event (e.g., Fast Refresh).

This forces re-hydration from active or failed runtime phases while preserving deterministic bookkeeping.

Trait Implementations§

Source§

impl Clone for NextjsBootstrapState

Source§

fn clone(&self) -> NextjsBootstrapState

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NextjsBootstrapState

Source§

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

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

impl Default for NextjsBootstrapState

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for NextjsBootstrapState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for NextjsBootstrapState

Source§

fn eq(&self, other: &NextjsBootstrapState) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for NextjsBootstrapState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for NextjsBootstrapState

Source§

impl StructuralPartialEq for NextjsBootstrapState

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
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: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,