Struct InstanceMetadata 

pub struct InstanceMetadata {
    pub ignore_unknown_instances: bool,
    pub instigating_source: Option<InstigatingSource>,
    pub relevant_paths: Vec<PathBuf>,
    pub context: InstanceContext,
    pub specified_id: Option<RojoRef>,
    pub middleware: Option<Middleware>,
    pub schema: Option<String>,
}

Rojo-specific metadata that can be associated with an instance or a snapshot of an instance.

Fields

ignore_unknown_instances: bool

Whether instances not present in the source should be ignored when live-syncing. This is useful when there are instances that Rojo does not manage.

instigating_source: Option<InstigatingSource>

If a change occurs to this instance, the instigating source is what should be run through the snapshot functions to regenerate it.

relevant_paths: Vec<PathBuf>

The paths that, when changed, could cause the function that generated this snapshot to generate a different snapshot. Paths should be included even if they don’t exist, since the presence of a file can change the outcome of a snapshot function.

For example, a file named foo.lua might have these relevant paths:

• foo.lua
• foo.meta.json (even if this file doesn’t exist!)

A directory named bar/ might have these:

• bar/
• bar/init.meta.json
• bar/init.lua
• bar/init.server.lua
• bar/init.client.lua
• bar/default.project.json

This path is used to make sure that file changes update all instances that may need updates.

context: InstanceContext

Contains information about this instance that should persist between snapshot invocations and is generally inherited.

If an instance has a piece of context attached to it, then the next time that instance’s instigating source is snapshotted directly, the same context will be passed into it.

specified_id: Option<RojoRef>

Indicates the ID used for Ref properties pointing to this Instance.

middleware: Option<Middleware>

The Middleware that was used to create this Instance. Should generally not be None except if the snapshotting process is not completed.

schema: Option<String>

A schema provided via a JSON file, if one exists. Will be None for all non-JSON middleware.

Implementations

impl InstanceMetadata

pub fn new() -> Self

pub fn ignore_unknown_instances(self, ignore_unknown_instances: bool) -> Self

pub fn instigating_source( self, instigating_source: impl Into<InstigatingSource>, ) -> Self

pub fn relevant_paths(self, relevant_paths: Vec<PathBuf>) -> Self

pub fn context(self, context: &InstanceContext) -> Self

pub fn specified_id(self, id: Option<RojoRef>) -> Self

pub fn middleware(self, middleware: Middleware) -> Self

pub fn schema(self, schema: Option<String>) -> Self

Trait Implementations

impl Clone for InstanceMetadata

fn clone(&self) -> InstanceMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceMetadata

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

Formats the value using the given formatter.

impl Default for InstanceMetadata

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InstanceMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InstanceMetadata

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for InstanceMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for InstanceMetadata