Struct StoreOpener 

pub struct StoreOpener { /* private fields */ }

Opens the store of a session’s files: the running session’s, an import’s, one /resume lists. By default a DirStore in the session’s directory (logs/, files/), which refuses a session from before rig-session/2 (SessionError::OldLayout). A plugin replaces it while the app is built, such as with a sealed store: app.insert_resource(StoreOpener::new(|dir| ..)).

Once every plugin is built the harness opens the running session’s SessionStore from the front’s own store (Front::session_store), else from this, and reads it before writing; a run whose session does not open or read is refused, unchanged. The harness marks the running session saved once its log first writes, so /resume lists it (not a sessionless run’s); a program that saves a new session through this marks it itself (SessionDir::mark_saved). Self::relist keeps the listing of a session no rig runs current.

Implementations

impl StoreOpener

pub fn new( open: impl Fn(&SessionDir) -> Result<Arc<dyn Store>, SessionError> + Send + Sync + 'static, ) -> Self

Stores that open opens.

pub fn open(&self, dir: &SessionDir) -> Result<Arc<dyn Store>, SessionError>

The store of the session in dir.

Errors

When the store cannot be opened, such as without its key, or holds a session from before rig-session/2.

pub fn relist(&self, store: &dyn Store, session: &Session) -> Result<()>

Brings the listing of the session session read from or saved to store, which no rig runs, up to it, as a running rig keeps its own: its listed values, its main agent’s model and message count, and when it changed (SessionMeta::relist). Every writer of a stopped session calls it after writing; edit_stopped and rewrite_stopped do.

Errors

When the listing cannot be written.

Trait Implementations

impl Clone for StoreOpener

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for StoreOpener

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for StoreOpener

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

Formats the value using the given formatter.

impl Default for StoreOpener

fn default() -> Self

Returns the “default value” for a type.

impl Resource for StoreOpener

where Self: Send + Sync + 'static,