Readability

This commit is contained in:
Jamie Hardt
2020-11-22 14:57:17 -08:00
parent e637dc86d3
commit 781e8769b0

View File

@@ -4,26 +4,35 @@ use super::fourcc::FourCC;
/// Errors returned by methods in this crate. /// Errors returned by methods in this crate.
#[derive(Debug)] #[derive(Debug)]
pub enum Error { pub enum Error {
/// An `io::Error` occurred /// An `io::Error` occurred
IOError(io::Error), IOError(io::Error),
/// The file does not begin with a recognized WAVE header /// The file does not begin with a recognized WAVE header
HeaderNotRecognized, HeaderNotRecognized,
/// A wave file with a 64-bit header does not contain /// A wave file with a 64-bit header does not contain
/// the required `ds64` metadata element /// the required `ds64` metadata element
MissingRequiredDS64, MissingRequiredDS64,
/// A data chunk required to complete the operation /// A data chunk required to complete the operation
/// is not present in the file /// is not present in the file
ChunkMissing { signature : FourCC }, ChunkMissing { signature : FourCC },
/// The file is formatted improperly /// The file is formatted improperly
FmtChunkAfterData, FmtChunkAfterData,
/// The file did not validate as a minimal WAV file /// The file did not validate as a minimal WAV file
NotMinimalWaveFile, NotMinimalWaveFile,
/// The `data` chunk is not aligned to the desired page /// The `data` chunk is not aligned to the desired page
/// boundary /// boundary
DataChunkNotAligned, DataChunkNotAligned,
/// The file cannot be converted into an RF64 file due /// The file cannot be converted into an RF64 file due
/// to its internal structure /// to its internal structure
InsufficientDS64Reservation {expected: u64, actual: u64}, InsufficientDS64Reservation {expected: u64, actual: u64},
/// The file is not optimized for writing new data /// The file is not optimized for writing new data
DataChunkNotPreparedForAppend DataChunkNotPreparedForAppend
} }