Struct hyperion::effects::EffectDefinition

pub struct EffectDefinition {
    pub name: String,
    pub file: PathBuf,
    pub script: String,
    pub args: Value,
    base_path: Arc<PathBuf>,
}

Fields

name: String

Friendly name of the effect

file: PathBuf

Path to the effect definition file

script: String

Path to the effect script

args: Value

Arguments to the effect script

base_path: Arc<PathBuf>

Path this definition is located in

Implementations

impl EffectDefinition

pub async fn read_dir( path: impl AsRef<Path> ) -> Result<Vec<Self>, EffectDefinitionError>

pub async fn read_file( path: impl AsRef<Path> ) -> Result<Self, EffectDefinitionError>

async fn from_file( path: &Path, base_path: Arc<PathBuf> ) -> Result<Self, EffectDefinitionError>

pub fn script_path(&self) -> Result<PathBuf, EffectDefinitionError>

Trait Implementations

impl Clone for EffectDefinition

fn clone(&self) -> EffectDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EffectDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectDefinition

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

Deserialize this value from the given Serde deserializer.

impl From<&EffectDefinition> for EffectDefinition

fn from(value: &EffectDefinition) -> Self

Converts to this type from the input type.

impl PartialEq<EffectDefinition> for EffectDefinition

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

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

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

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

impl Serialize for EffectDefinition

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 EffectDefinition