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

#![cfg_attr(all(test, feature = "unstable"), feature(test))]

//! A library to read and write ID3v2 tags. ID3 versions v2.2, v2.3, and v2.4 are supported.
//!
//! # Modifying an existing tag
//!
//! ```no_run
//! use id3::{Tag, Version};
//!
//! let mut tag = Tag::read_from_path("music.mp3").unwrap();
//!
//! // print the artist the hard way
//! println!("{}", tag.get("TPE1").unwrap().content().text().unwrap());
//!
//! // or print it the easy way
//! println!("{}", tag.artist().unwrap());
//!
//! tag.write_to_path("music.mp3", Version::Id3v24).unwrap();
//! ```
//!
//! # Creating a new tag
//!
//! ```no_run
//! use id3::{Tag, Frame, Version};
//! use id3::frame::Content;
//!
//! let mut tag = Tag::new();
//!
//! // set the album the hard way
//! let frame = Frame::with_content("TALB", Content::Text("album".to_string()));
//! tag.add_frame(frame);
//!
//! // or set it the easy way
//! tag.set_album("album");
//!
//! tag.write_to_path("music.mp3", Version::Id3v24).unwrap();
//! ```
//!
//! # Resources
//!
//! * ID3v2.2 http://id3.org/id3v2-00
//! * ID3v2.3 http://id3.org/id3v2.3.0
//! * ID3v2.4 http://id3.org/id3v2.4.0-structure

#![warn(missing_docs)]

#[macro_use]
extern crate derive_builder;

pub use crate::error::{Error, ErrorKind, Result};
pub use crate::frame::{Content, Frame, Timestamp};
pub use crate::stream::tag::{Encoder, EncoderBuilder};
pub use crate::tag::{Tag, Version};

/// Contains types and methods for operating on ID3 frames.
pub mod frame;
/// Utilities for working with ID3v1 tags.
pub mod v1;

mod error;
mod storage;
mod stream;
mod tag;
mod util;