Struct atm::storage::batch_tar_file::BatchTarFile

pub struct BatchTarFile { /* fields omitted */ }

Nested tar archive storage backend, where each entry in the archive is a gzip-compressed tar archive containing MIDI files. Use for the largest datasets where compression, or output file size, is of the utmost importance. Choosing a batch size (and compression level) such that each compressed tar archive aligns with 512 bytes will ensure that no space is wasted in the top-level archive. For example, if a batch size of 25 compresses to 515 bytes, then each entry will take 1,536 bytes (512 for header plus 1024 for data). However, if a batch compresses to 510 bytes, then each entry will take 1024 bytes, with only 2 bytes extra. Keep in mind that higher compression levels will reduce throughput of the program.

Implementations

impl BatchTarFile

pub fn new<P: AsRef<Path>>(
    target_path: P,
    batch_size: u32,
    num_notes: u32,
    melody_length: u32,
    max_files: u32,
    partition_depth: u32,
    batch_compression: Option<Compression>,
    batch_mode: Option<u32>
) -> Result<Self, TarArchiveError>

Create new BatchTarFile instance

Trait Implementations

impl IntoInner for BatchTarFile

type Inner = BufWriter<File>

Type of inner object

fn into_inner(self) -> Result<Self::Inner, Self::Error>

Finish writing storage backends and return the inner object

impl StorageBackend for BatchTarFile

type Error = TarArchiveError

Error type for storage operations

fn append_file(
    &mut self,
    mfile: MIDIFile,
    mode: Option<u32>
) -> Result<(), Self::Error>

Append MIDI file to storage backend

fn finish(&mut self) -> Result<(), Self::Error>

Conduct cleanup of storage backend and close for writing

fn append_melody(
    &mut self,
    melody: MIDINoteVec,
    mode: Option<u32>
) -> Result<(), Self::Error>

Convert melody to MIDI file and append to storage backend