lofty 0.25.3

Audio metadata library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! MP4 file/tag error types

use crate::error::{
	AllocationError, FileParseError, NotEnoughDataError, SizeMismatchError, TextDecodingError,
	TooMuchDataError,
};
use crate::file::FileType;
use crate::mp4::AtomIdent;

use std::borrow::Cow;

use lofty_attr::LoftyError;

// Exports
pub use super::ilst::atom::AtomMismatchError;

/// Failed to parse a [`Mp4File`]
///
/// [`Mp4File`]: crate::mp4::Mp4File
#[derive(LoftyError)]
#[error(message = "failed to parse MP4 file")]
pub struct Mp4ParseError {
	#[error(from(
		std::io::Error,
		crate::error::TagParseError,
		AtomParseError,
		crate::error::UnknownFormatError,
		crate::error::NotEnoughDataError,
	))]
	source: Box<dyn core::error::Error + Send + Sync + 'static>,
}

impl Mp4ParseError {
	pub(super) fn missing_moov() -> Self {
		Self::message("file does not contain a \"moov\" atom")
	}

	pub(super) fn message(message: &'static str) -> Self {
		Self {
			source: message.into(),
		}
	}
}

impl From<Mp4ParseError> for FileParseError {
	fn from(input: Mp4ParseError) -> FileParseError {
		Self::new(FileType::Mp4, input.source)
	}
}

/// Failed to parse an atom
pub struct AtomParseError {
	ident: Option<AtomIdent<'static>>,
	source: Box<dyn core::error::Error + Send + Sync + 'static>,
}

impl AtomParseError {
	pub(super) fn new(
		ident: AtomIdent<'static>,
		source: Box<dyn core::error::Error + Send + Sync + 'static>,
	) -> Self {
		Self {
			ident: Some(ident),
			source,
		}
	}

	pub(super) fn with_ident(mut self, ident: AtomIdent<'_>) -> Self {
		self.ident = Some(ident.into_owned());
		self
	}

	/// Set the ident for this error, only if one isn't already set
	pub(super) fn with_ident_if_not_present(self, ident: AtomIdent<'_>) -> Self {
		if self.ident.is_some() {
			return self;
		}

		self.with_ident(ident)
	}

	pub(super) fn message(
		ident: Option<AtomIdent<'_>>,
		message: impl Into<Cow<'static, str>>,
	) -> Self {
		let message = message.into();
		Self {
			ident: ident.map(AtomIdent::into_owned),
			source: message.into(),
		}
	}
}

impl core::fmt::Display for AtomParseError {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		match &self.ident {
			Some(ident) => write!(f, "failed to parse atom '{ident}'"),
			None => write!(f, "failed to parse atom"),
		}
	}
}

impl core::fmt::Debug for AtomParseError {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
		f.debug_struct("AtomParseError").finish_non_exhaustive()
	}
}

impl core::error::Error for AtomParseError {
	fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
		Some(&*self.source)
	}
}

impl From<std::io::Error> for AtomParseError {
	fn from(input: std::io::Error) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<SizeMismatchError> for AtomParseError {
	fn from(input: SizeMismatchError) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<TooMuchDataError> for AtomParseError {
	fn from(input: TooMuchDataError) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<AllocationError> for AtomParseError {
	fn from(input: AllocationError) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<NotEnoughDataError> for AtomParseError {
	fn from(input: NotEnoughDataError) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<TextDecodingError> for AtomParseError {
	fn from(input: TextDecodingError) -> Self {
		Self {
			ident: None,
			source: Box::new(input),
		}
	}
}

impl From<AtomParseError> for FileParseError {
	fn from(input: AtomParseError) -> Self {
		Mp4ParseError::from(input).into()
	}
}