Struct darkroom::MetaFrame

pub struct MetaFrame {
    pub path: PathBuf,
    pub name: String,
    pub reel_name: String,
    pub step: f32,
    pub frame_type: FrameType,
}

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

path: PathBuf

name: String

reel_name: String

step: f32

frame_type: FrameType

Implementations

impl MetaFrame

pub fn get_filename(&self) -> Option<String>

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<MetaFrame> 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: &MetaFrame) -> bool

This method tests for !=.

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.