Struct RestorationScope 

pub struct RestorationScope { /* private fields */ }

A restoration location supplied by the runtime to an opt-in state owner.

Application code normally receives scopes from runtime build APIs rather than constructing them. new remains public so embedded runtimes and deterministic in-memory tests can provide their own backend.

Implementations

impl RestorationScope

pub fn root(backend: Rc<dyn RestorationBackend>) -> Self

Creates the application-root restoration scope for a backend.

pub fn new( backend: Rc<dyn RestorationBackend>, path: impl IntoIterator<Item = RestorationKey>, ) -> Self

Creates a scope at an already-validated, fully-qualified path.

pub fn child_unchecked(&self, key: RestorationKey) -> Self

Extends this scope with one already-registered stable child segment.

Runtime is responsible for registering and checking sibling scope identities before it exposes this scope. This method deliberately does no implicit child numbering or position-based identity assignment.

pub fn child(&self, key: RestorationKey) -> Self

Extends this scope with one stable child segment.

This is pure namespacing: it performs no duplicate-scope validation. The runtime claims window scopes automatically, but application-owned dynamic scopes that must be unique while mounted should additionally hold a runtime scope claim (see RestorationHandle::claim_scope); two live writers to one path otherwise collide last-write-wins.

pub fn is_root(&self) -> bool

pub fn path(&self) -> &[RestorationKey]

Returns the stable hierarchical path owned by this scope.

pub fn get_json(&self, key: &RestorationKey) -> Option<Value>

Reads the JSON value stored under a stable value key.

pub fn set_json(&self, key: &RestorationKey, value: Value)

Stores a JSON value under a stable value key.

This only updates the runtime manager’s in-memory snapshot. Its persistence policy determines when an asynchronous disk save occurs.

pub fn remove(&self, key: &RestorationKey)

Removes the JSON value stored under a stable value key.

pub fn note_restoration_outcome(&self, restored: u64, invalid: u64)

Forwards a recovery outcome to the backend. Scroll restoration and typed-value fallbacks report here; backends that do not count outcomes ignore the call.

Trait Implementations

impl Clone for RestorationScope

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RestorationScope

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

Formats the value using the given formatter.