Enum yy_boss::SerializedData

pub enum SerializedData {
    Value {
        data: String,
    },
    Filepath {
        data: PathBuf,
    },
    DefaultValue,
}

The data which is passed in as part of a Command. Each tag represents a different way to pass data into the given Resource.

NB: the type of data which is passed in is determined by the containing Command.

Variants

Value

The data itself, represented in some valid utf8 format. Scripts, yyfiles, and most resources will likely be passed in with this tag.

Errors

It is an error to try to pass in any binary data which cannot be represented in utf8 format. To pass in images and other similar files, prefer using Filepath.

Fields of Value

data: String

Filepath

A path to the data iself, from some relevant directory. Symbolic links will not be followed.

Anything, including gml and yy files, can be passed in with this tag, though its use is primarily for binary files, such as images and sound files.

Fields of Filepath

data: PathBuf

DefaultValue

A default for the type of data provided, which the YypBoss will generate for users.

For example, to create a new Script, a user would want the Script's AssociatedData, which is the gml file, to be blank. This will generate such an empty string. In a more complex example, if a user is making a new Object, and is fine with default settings, included an autogenerated name, this tag will do that. Since all data can be edited afterwards, this can provide a convenient way to generate new objects.

Trait Implementations

impl Clone for SerializedData

pub fn clone(&self) -> SerializedData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SerializedData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SerializedData

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for SerializedData

impl PartialEq<SerializedData> for SerializedData

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for SerializedData

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

Serialize this value into the given Serde serializer.

impl StructuralEq for SerializedData

impl StructuralPartialEq for SerializedData