Struct ProjectWorkspace 

pub struct ProjectWorkspace(pub Arc<dyn Workspace>);

The workspace the tools act on: this machine’s (Local) unless a plugin puts another in while the app is built, such as one reached over SSH. Paths in ProjectRoot, WorkDir and tools’ facts (FilesRead, FilesChanged) are in it. Run project commands, such as git, with its spawn, so they follow it; other plugins learn it is not this machine from its host.

The main-thread rule. Tools call it inside blocking. A system calls it inline only when host() is None; for another workspace it reads as Running::spawn work, under a hold (HoldOf) on what waits for it, so a remote workspace never blocks a frame and a local one keeps its timing.

use std::sync::Arc;
use rig_harness::prelude::*;
use rig_harness::rig_tools::workspace::Local;

let mut app = App::new();
// A plugin of another workspace inserts its own in `build`, with the
// project's path there.
app.insert_resource(ProjectWorkspace(Arc::new(Local)))
    .insert_resource(ProjectRoot("/srv/app".into()));
assert!(app.world().resource::<ProjectWorkspace>().0.host().is_none());

Tuple Fields

0: Arc<dyn Workspace>

Trait Implementations

impl Clone for ProjectWorkspace

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 ProjectWorkspace

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 ProjectWorkspace

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

Formats the value using the given formatter.

impl Default for ProjectWorkspace

This machine.

fn default() -> Self

Returns the “default value” for a type.

impl Resource for ProjectWorkspace

where Self: Send + Sync + 'static,