Module metadata

For handling a FLAC file’s metadata blocks

Many items are capitalized simply because they were capitalized in the original FLAC format documentation.

Metadata Blocks

FLAC supports seven different metadata block types

Block Type	Purpose
STREAMINFO	stream information such as sample rate, channel count, etc.
PADDING	empty data which can easily be resized as needed
APPLICATION	application-specific data such as foreign RIFF WAVE chunks
SEEKTABLE	to allow for more efficient seeking within a FLAC file
VORBIS_COMMENT	textual metadata such as track title, artist name, album name, etc.
CUESHEET	the original disc’s layout, for CD images
PICTURE	embedded image files such as cover art

Modules

contiguous

Types for collections which must be contiguous

cuesheet

Types related to the CUESHEET metadata block

fields

Vorbis comment metadata tag fields

Structs

Application

An APPLICATION metadata block

BlockHeader

A FLAC metadata block header

BlockIterator

An iterator over FLAC metadata blocks

BlockList

A collection of metadata blocks

BlockSize

A 24-bit block size value, with safeguards against overflow

BlockSizeOverflow

An error that occurs when trying to build an overly large BlockSize

ChannelMask

The channel mask

Padding

A PADDING metadata block

Picture

A PICTURE metadata block

SeekTable

A SEEKTABLE metadata block

Streaminfo

A STREAMINFO metadata block

VorbisComment

A VORBIS_COMMENT metadata block

Enums

Block

Any possible FLAC metadata block

BlockRef

A shared reference to a metadata block

BlockType

A defined FLAC metadata block type

Channel

An individual channel mask channel

Cuesheet

A CUESHEET metadata block

CuesheetError

An error when trying to parse cue sheet data

InvalidPicture

An error when trying to identify a picture’s metrics

OptionalBlockType

A block type for optional FLAC metadata blocks

PictureType

Defined variants of PICTURE type

SeekPoint

An individual SEEKTABLE seek point

Traits

AsBlockRef

A trait for items which can make cheap BlockRef values.

Metadata

A trait for indicating various pieces of FLAC stream metadata

MetadataBlock

A type of FLAC metadata block

OptionalMetadataBlock

A type of FLAC metadata block which is not required

Functions

block

Returns first instance of the given block from the given path

blocks

Returns iterator of blocks from the given path

read_block

Returns first instance of the given block from the given reader

read_blocks

Returns iterator of blocks from the given reader

update

Given a Path, attempts to update FLAC metadata blocks

update_file

Given open file, attempts to update its metadata blocks

write_blocks

Writes iterator of blocks to the given writer.