Struct PluginData 

pub struct PluginData {
    pub session: Arc<dyn Files>,
    pub project: Arc<dyn Files>,
    pub user: Arc<dyn Files>,
}

Where plugins keep their files: per session, per project and per user. Not in the project’s own directory: a plugin’s data is the user’s, never committed and never read from a checkout someone else made. Inserted once every plugin is built, in every run, unless the app has one: a run without a saved session keeps session in memory.

Fields

session: Arc<dyn Files>

This session’s: plugins/ in the session’s store, which a delete removes.

project: Arc<dyn Files>

This project’s, for this user, whichever session works in it: $RIG_HOME/projects/<name>-<key>/, the key from the project’s canonical path, so every spelling of it shares one.

user: Arc<dyn Files>

Across sessions and projects: $RIG_HOME/data/.

Implementations

impl PluginData

pub fn of( stores: &StoreOpener, dir: &SessionDir, ) -> Result<Arc<dyn Files>, SessionError>

The plugin files of the saved session in dir, kept in the store stores opens for it (plugins/ of that store): what PluginData::session is in a run of that session.

Errors

When its store does not open.

Trait Implementations

impl Clone for PluginData

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 PluginData

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 Resource for PluginData

where Self: Send + Sync + 'static,