Skip to content

Add optional serde support for *Type enums #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 9, 2025
Merged

Add optional serde support for *Type enums #534

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3369767
feat: add optional serde support for *Type enums
Lepidopteran Aug 2, 2025
1a43c18
chore: remove optional serde support for PictureInformation
Lepidopteran Aug 2, 2025
3bf743e
refactor: allow unsafe derive deserialize for `*Type` enums
Lepidopteran Aug 2, 2025
4414cc8
MimeType: Remove `serde` support
Serial-ATA Aug 9, 2025
59daf3a
changelog: Add entry for new `serde` feature
Serial-ATA Aug 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lofty/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ paste = "1.0.15"
[features]
default = ["id3v2_compression_support"]
id3v2_compression_support = ["dep:flate2"]
serde = ["dep:serde"]

[dependencies.serde]
version = "1.0"
features = ["derive"]
optional = true

[dev-dependencies]
# WAV properties validity tests
Expand Down
2 changes: 2 additions & 0 deletions lofty/src/file/file_type.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ use std::ffi::OsStr;
use std::path::Path;

/// The type of file read
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
#[allow(clippy::unsafe_derive_deserialize)]
#[allow(missing_docs)]
#[non_exhaustive]
pub enum FileType {
Expand Down
4 changes: 4 additions & 0 deletions lofty/src/picture.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ pub const APE_PICTURE_TYPES: [&str; 21] = [
];

/// MIME types for pictures.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
#[allow(clippy::unsafe_derive_deserialize)]
#[non_exhaustive]
pub enum MimeType {
/// PNG image
Expand Down Expand Up @@ -130,6 +132,8 @@ impl Display for MimeType {

/// The picture type, according to ID3v2 APIC
#[allow(missing_docs)]
#[allow(clippy::unsafe_derive_deserialize)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
#[non_exhaustive]
pub enum PictureType {
Expand Down
2 changes: 2 additions & 0 deletions lofty/src/tag/tag_type.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ use std::fs::OpenOptions;
use std::path::Path;

/// The tag's format
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[allow(clippy::unsafe_derive_deserialize)]
#[non_exhaustive]
pub enum TagType {
/// This covers both APEv1 and APEv2 as it doesn't matter much
Expand Down