Struct hltas::types::HLTAS

pub struct HLTAS {
    pub properties: Properties,
    pub lines: Vec<Line>,
}

A HLTAS script.

Fields

properties: Properties

Properties before the frames section.

lines: Vec<Line>

Contents of the frames section.

Implementations

impl HLTAS

pub fn from_str(input: &str) -> Result<Self, Error<'_>>

Parses a .hltas script.

Examples

use std::fs::read_to_string;
use hltas::HLTAS;

let contents = read_to_string("script.hltas")?;
match HLTAS::from_str(&contents) {
    Ok(hltas) => { /* ... */ }

    // The errors are pretty-printed with context.
    Err(error) => println!("{}", error),
}

pub fn to_writer<W: Write>(&self, writer: W) -> Result<(), GenError>

Outputs the script in the .hltas format.

Examples

use std::fs::File;
use hltas::HLTAS;

fn save_script(hltas: &HLTAS) -> Result<(), Box<dyn std::error::Error>> {
    let file = File::create("script.hltas")?;
    hltas.to_writer(file)?;
    Ok(())
}

pub fn frame_bulks( &self ) -> FilterMap<Iter<'_, Line>, fn(_: &Line) -> Option<&FrameBulk>>

Returns an iterator over frame bulks of the script.

Examples

use hltas::HLTAS;

fn check_frame_bulks(hltas: &HLTAS) {
    for frame_bulk in hltas.frame_bulks() {
        // ...
    }
}

pub fn frame_bulks_mut( &mut self ) -> FilterMap<IterMut<'_, Line>, fn(_: &mut Line) -> Option<&mut FrameBulk>>

Returns an iterator over mutable frame bulks of the script.

Examples

use hltas::HLTAS;

fn modify_frame_bulks(hltas: &mut HLTAS) {
    for frame_bulk in hltas.frame_bulks_mut() {
        // ...
    }
}

Trait Implementations

impl Clone for HLTAS

fn clone(&self) -> HLTAS

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HLTAS

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

Formats the value using the given formatter.

impl Default for HLTAS

fn default() -> HLTAS

Returns the “default value” for a type.

impl PartialEq<HLTAS> for HLTAS

fn eq(&self, other: &HLTAS) -> 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 StructuralPartialEq for HLTAS