Struct Meta

pub struct Meta {
    pub title: String,
    pub author: String,
    pub group: String,
    pub date: String,
    pub size: u32,
    pub type: (u8, u8),
    pub width: u16,
    pub height: u16,
    pub flags: u8,
    pub font: String,
    pub notes: Vec<String>,
}

A structure representing a file’s metadata

Fields

title: String

The image’s title

author: String

The image’s author

group: String

The image author’s team or group

date: String

The image creation date, in the YYYYMMDD format

size: u32

The size of the file, sans this metadata

type: (u8, u8)

The type of this file

Only supported values are

• (0, 0) → None (effectively, Character/ANSI)
• (1, 0) → Character/ASCII
• (1, 1) → Character/ANSI

See https://www.acid.org/info/sauce/sauce.htm#FileType

width: u16

Width of the image

height: u16

Height of the image

flags: u8

A bitfield of flags that define how to process an image

See https://www.acid.org/info/sauce/sauce.htm#ANSiFlags

font: String

The name of the font this image uses

Only IBM VGA is supported.

notes: Vec<String>

A list of comments on this image

Implementations

impl Meta

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

Wrap the title in an Option.

See title field

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

Wrap the author in an Option.

See author field

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

Wrap the group in an Option.

See group field

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

Wrap the date in an Option.

See date field

pub fn size(&self) -> u32

Fetch the size.

See size field

pub fn type(&self) -> (u8, u8)

Fetch the type if type != (0, 0), otherwise the default.

See type field

See Meta::default

pub fn width(&self) -> u16

Fetch the width if width > 0, otherwise the default.

See width field

See Meta::default

pub fn height(&self) -> u16

Fetch the height if height > 0, otherwise the default.

See height field

See Meta::default

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

Get both the width and the height.

See width method

See height method

pub fn flags(&self) -> (u8, u8, u8)

Fetch the flags, split into (AR, LS, B).

See flags field

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

Fetch the font if font != "", otherwise the default.

See font field

pub fn font_face_otb(&self) -> &Face<'_>

Font face, in OTB format.

See font field

pub fn font_face_woff(&self) -> &[u8]

Font face, in WOFF format.

See font field

pub fn notes(&self) -> &Vec<String>

Fetch the notes.

See notes field

pub fn stretch(&self) -> f64

Compute the stretch required for a given aspect ratio.

See aspect_ratio method

pub fn aspect_ratio(&self) -> (u8, u8)

Compute the aspect ratio.

See flags field

pub fn font_width(&self) -> u8

Font width.

See flags field

pub fn font_height(&self) -> u8

Font height.

pub fn font_size(&self) -> (u8, u8)

Font dimensions.

See font_width method

See font_height method

Trait Implementations

impl Clone for Meta

fn clone(&self) -> Meta

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Meta

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

Formats the value using the given formatter.

impl Default for Meta

A minimal meta

Sets all defaults as interpreted when undefined

fn default() -> Meta

Get default meta values

impl PartialEq for Meta

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

impl StructuralPartialEq for Meta