Struct SwfHeaders

pub struct SwfHeaders { /* private fields */ }

The primary struct, managing all the parsing and storage of SWF header information.

Implementations

impl SwfHeaders

pub fn open<T: AsRef<Path>>(path: T) -> Result<(Self, DecodedSwf), Error>

Wraps over read_from(), taking a path and opening it for you.

Examples

use swf_headers::SwfHeaders;
if let Ok((headers, decoded)) = SwfHeaders::open("example.swf") {
    // ...
}

pub fn read_from(file: File) -> Result<(Self, DecodedSwf), Error>

Takes a SWF file and parses its headers, returning the header struct along with a readable DecodedSwf if you wish to continue parsing the file.

The vast bulk of SWF parsing happens in here. The code is documented, so you can read through the source if you want to understand how it all works.

Examples

use std::fs::File;
use swf_headers::SwfHeaders;
if let Ok(file) = File::open("example.swf") {
    let (headers, decoded) = SwfHeaders::read_from(file).unwrap();
    // ...
}

pub fn signature(&self) -> Signature

Returns the signature as an enum representing all valid values.

pub fn version(&self) -> u8

Returns the version number.

pub fn file_length(&self) -> u32

Returns the uncompressed total file length in bytes.

pub fn dimensions_twips(&self) -> (u32, u32)

Returns the dimensions in twips (the measurement unit flash uses, 1/20th of a pixel).

pub fn dimensions(&self) -> (u32, u32)

Returns the dimensions in pixels (converted from twips, sometimes losing accuracy).

pub fn frame_rate(&self) -> u16

Returns the frame rate (note: does not yet handle fractional framerates).

pub fn frame_count(&self) -> u16

Returns the frame count.

Trait Implementations

impl Clone for SwfHeaders

fn clone(&self) -> SwfHeaders

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwfHeaders

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

Formats the value using the given formatter.

impl PartialEq for SwfHeaders

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SwfHeaders

impl StructuralPartialEq for SwfHeaders