Enum Middleware 

pub enum Middleware {
    Csv,
    JsonModel,
    Json,
    ServerScript,
    ClientScript,
    ModuleScript,
    PluginScript,
    LegacyClientScript,
    LegacyServerScript,
    RunContextServerScript,
    RunContextClientScript,
    Project,
    Rbxm,
    Rbxmx,
    Toml,
    Text,
    Yaml,
    Ignore,
    Dir,
    ServerScriptDir,
    ClientScriptDir,
    PluginScriptDir,
    ModuleScriptDir,
    CsvDir,
}

Represents a possible ‘transformer’ used by Rojo to turn a file system item into a Roblox Instance. Missing from this list is metadata. This is deliberate, as metadata is not a snapshot middleware.

Directories cannot be used for sync rules so they’re ignored by Serde.

Variants

Csv

JsonModel

Json

ServerScript

ClientScript

ModuleScript

PluginScript

LegacyClientScript

LegacyServerScript

RunContextServerScript

RunContextClientScript

Project

Rbxm

Rbxmx

Toml

Text

Yaml

Ignore

Dir

ServerScriptDir

ClientScriptDir

PluginScriptDir

ModuleScriptDir

CsvDir

Implementations

impl Middleware

pub fn syncback<'sync>( &self, snapshot: &SyncbackSnapshot<'sync>, ) -> Result<SyncbackReturn<'sync>>

Runs the syncback mechanism for the provided middleware given a SyncbackSnapshot.

pub fn is_dir(&self) -> bool

Returns whether this particular middleware would become a directory.

pub fn handles_own_properties(&self) -> bool

Returns whether this particular middleware sets its own properties. This applies to things like JsonModel and Project, since they set properties without needing a meta.json file.

It does not cover middleware like ServerScript or Csv because they need a meta.json file to set properties that aren’t their designated ‘special’ properties.

pub fn middleware_for_path( vfs: &Vfs, sync_rules: &[SyncRule], path: &Path, ) -> Result<Option<Self>>

Attempts to return a middleware that should be used for the given path.

Returns Err only if the Vfs cannot read information about the path.

Trait Implementations

impl Clone for Middleware

fn clone(&self) -> Middleware

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Middleware

impl Debug for Middleware

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Middleware

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Middleware

fn eq(&self, other: &Middleware) -> 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 Middleware

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 Middleware