Struct GenericEffect 

pub struct GenericEffect {
    pub otio_schema: String,
    pub name: String,
    pub metadata: Map<String, Value>,
    pub effect_name: String,
    pub extra: Map<String, Value>,
}

Effect.1: a named effect; ffcine’s parameters live in metadata.ffcine.

Fields

otio_schema: String

name: String

metadata: Map<String, Value>

effect_name: String

extra: Map<String, Value>

Implementations

impl GenericEffect

pub fn ffcine(schema: &str, params: Map<String, Value>) -> Self

An ffcine effect: effect_name is the schema name, params go to metadata.ffcine with "schema": schema. schema is "ffcine.<domain>.<name>/<major>".

pub fn ffcine_schema(&self) -> Option<(&str, u32)>

metadata.ffcine.schema split into name and major version.

pub fn ffcine_params<T: DeserializeOwned>( &self, name: &str, major: u32, ) -> Option<Result<T>>

metadata.ffcine without schema, decoded as T, if this effect is name at major.

impl GenericEffect

pub fn new(name: impl Into<String>, effect_name: impl Into<String>) -> Self

Trait Implementations

impl Clone for GenericEffect

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericEffect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GenericEffect

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasMetadata for GenericEffect

fn metadata(&self) -> &Map<String, Value>

fn metadata_mut(&mut self) -> &mut Map<String, Value>

fn ffcine(&self) -> Option<&Map<String, Value>>

metadata.ffcine, if it is an object.

fn ffcine_mut(&mut self) -> &mut Map<String, Value>

metadata.ffcine, created if missing (a non-object value there is replaced).

fn ffcine_value(&self, key: &str) -> Option<&Value>

metadata.ffcine.<key>.

fn ffcine_get<T: DeserializeOwned>(&self, key: &str) -> Option<Result<T>>

metadata.ffcine.<key> decoded as T; None if absent.

fn ffcine_set<T: Serialize + ?Sized>( &mut self, key: &str, value: &T, ) -> Result<()>

Sets metadata.ffcine.<key>.

fn ffcine_id(&self) -> Option<&str>

metadata.ffcine.id.

fn set_ffcine_id(&mut self, id: impl Into<String>)

fn foreign(&self, app: &str) -> Option<&Value>

metadata.ffcine.foreign.<app>.

fn set_foreign(&mut self, app: &str, value: Value)

Sets metadata.ffcine.foreign.<app>.

fn insert_foreign(&mut self, app: &str, key: &str, value: Value)

Inserts key: value into the object at metadata.ffcine.foreign.<app>.

fn move_to_foreign(&mut self, key: &str, app: &str) -> bool

Moves an OTIO adapter’s namespace (metadata.<key>, e.g. Resolve_OTIO) to metadata.ffcine.foreign.<app>. Returns whether there was one.

impl PartialEq for GenericEffect

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GenericEffect

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 GenericEffect