Struct Module 

pub struct Module {

    pub name: Name,
    pub message: String,
    pub highlight: (u8, u8),
    pub made_with_version: u16,
    pub compatible_with_version: u16,
    pub flags: ModuleFlags,
    pub global_volume: RangedU8<0, 128>,
    pub sample_volume: RangedU8<0, 128>,
    pub speed: RangedU8<1, 255>,
    pub tempo: RangedU8<31, 255>,
    pub pan_separation: RangedU8<0, 128>,
    pub pitch_wheel_depth: u8,
    pub init_channel_panning: [u8; 64],
    pub init_channel_volume: [u8; 64],
    pub orders: Vec<Order>,
    pub instruments: Vec<Instrument>,
    pub samples: Vec<Sample>,
    pub patterns: Vec<Pattern>,
}

Fields

name: Name

Song Name, null-terminated (but may also contain nulls)

message: String

Comment message

highlight: (u8, u8)

Rows per Measure highlight, Rows per Beat highlight

made_with_version: u16

“Made With” Tracker

compatible_with_version: u16

“Compatible With” Tracker

flags: ModuleFlags

combined Header Flags and Special Flags, for embedding extra information

global_volume: RangedU8<0, 128>

Global Volume (0…128)

sample_volume: RangedU8<0, 128>

Sample Volume (0…128)

speed: RangedU8<1, 255>

Initial Speed (1…255)

tempo: RangedU8<31, 255>

Initial Tempo (31…255)

pan_separation: RangedU8<0, 128>

Pan Separation (0…128)

pitch_wheel_depth: u8

Pitch Wheel Depth

init_channel_panning: [u8; 64]

Initial Channel Panning

init_channel_volume: [u8; 64]

Initial Channel Volume

orders: Vec<Order>

Orders

instruments: Vec<Instrument>

Instrument headers (without samples)

samples: Vec<Sample>

Samples

patterns: Vec<Pattern>

Patterns

Implementations

impl Module

pub fn ordered_patterns(&self) -> impl Iterator<Item = &Pattern> + '_

Returns an iterator over patterns as listed in the orders list.

It can yield any pattern multiple times or not yield some patterns at all.

pub fn active_channels(&self) -> ActiveChannels

Returns active channels when playing the module.

Does not account for channels in patterns which are not present in the orders list.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Get<InstrumentId> for Module

type Output = Instrument

fn get(&self, index: InstrumentId) -> Option<&Self::Output>

impl Get<PatternId> for Module

type Output = Pattern

fn get(&self, index: PatternId) -> Option<&Self::Output>

impl Get<SampleId> for Module

type Output = Sample

fn get(&self, index: SampleId) -> Option<&Self::Output>

impl Index<&InstrumentId> for Module

type Output = <Module as Get<InstrumentId>>::Output

The returned type after indexing.

fn index(&self, index: &InstrumentId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<&PatternId> for Module

type Output = <Module as Get<PatternId>>::Output

The returned type after indexing.

fn index(&self, index: &PatternId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<&SampleId> for Module

type Output = <Module as Get<SampleId>>::Output

The returned type after indexing.

fn index(&self, index: &SampleId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<InstrumentId> for Module

type Output = <Module as Get<InstrumentId>>::Output

The returned type after indexing.

fn index(&self, index: InstrumentId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<PatternId> for Module

type Output = <Module as Get<PatternId>>::Output

The returned type after indexing.

fn index(&self, index: PatternId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Index<SampleId> for Module

type Output = <Module as Get<SampleId>>::Output

The returned type after indexing.

fn index(&self, index: SampleId) -> &Self::Output

Performs the indexing (container[index]) operation.