Struct darkroom::MetaFrame

pub struct MetaFrame {
    pub reel_name: String,
    pub frame_type: FrameType,
    pub alt_name: Option<String>,
    pub name: String,
    pub path: PathBuf,
    pub step_f32: f32,
    /* private fields */
}

MetaFrame holds the metadata needed for sequential Frame execution and Take generation.

Frame filename anatomy:

┌─────────── Reel name              // usr
│   ┌─────── Sequence number        // 01
│   │ ┌───── Return type            // se
│   │ │  ┌── Command name           // createuser
▼   ▼ ▼  ▼
usr.01se.createuser.fr.json
                    ▲
                    └─ Frame suffix // .fr.json

Fields

reel_name: String

frame_type: FrameType

alt_name: Option<String>

name: String

path: PathBuf

step_f32: f32

Implementations

impl MetaFrame

pub fn get_filename(&self) -> String

pub fn get_cut_file<P>(&self, dir: P) -> PathBuf

where P: AsRef<Path>,

Trait Implementations

impl Clone for MetaFrame

fn clone(&self) -> MetaFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetaFrame

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

Formats the value using the given formatter.

impl PartialEq for MetaFrame

fn eq(&self, other: &MetaFrame) -> 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 TryFrom<&PathBuf> for MetaFrame

type Error = FrError

The type returned in the event of a conversion error.

fn try_from( p: &PathBuf ) -> Result<MetaFrame, <MetaFrame as TryFrom<&PathBuf>>::Error>

Performs the conversion.

impl StructuralPartialEq for MetaFrame