lofty 0.24.0

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

use crate::error::Result;
use crate::id3::v2::{FrameFlags, FrameHeader, FrameId};

use std::borrow::Cow;
use std::io::Read;

/// A binary fallback for all unknown `ID3v2` frames
#[derive(Clone, Debug, Eq, PartialEq, Hash)]
pub struct BinaryFrame<'a> {
	pub(crate) header: FrameHeader<'a>,
	/// The binary data
	pub data: Cow<'a, [u8]>,
}

impl<'a> BinaryFrame<'a> {
	/// Create a new [`BinaryFrame`]
	pub fn new(id: FrameId<'a>, data: impl Into<Cow<'a, [u8]>>) -> Self {
		let header = FrameHeader::new(id, FrameFlags::default());
		Self {
			header,
			data: data.into(),
		}
	}

	/// Get the ID for the frame
	pub fn id(&self) -> &FrameId<'_> {
		&self.header.id
	}

	/// Get the flags for the frame
	pub fn flags(&self) -> FrameFlags {
		self.header.flags
	}

	/// Set the flags for the frame
	pub fn set_flags(&mut self, flags: FrameFlags) {
		self.header.flags = flags;
	}

	/// Read a [`BinaryFrame`]
	///
	/// NOTE: This will exhaust the entire reader
	///
	/// # Errors
	///
	/// * Failure to read from `reader`
	pub fn parse<R>(reader: &mut R, id: FrameId<'a>, frame_flags: FrameFlags) -> Result<Self>
	where
		R: Read,
	{
		let mut data = Vec::new();
		reader.read_to_end(&mut data)?;

		let header = FrameHeader::new(id, frame_flags);
		Ok(BinaryFrame {
			header,
			data: Cow::Owned(data),
		})
	}

	/// Convert an [`BinaryFrame`] to a byte vec
	pub fn as_bytes(&self) -> Vec<u8> {
		let Self { data, .. } = self;
		data.to_vec()
	}
}

impl BinaryFrame<'static> {
	pub(crate) fn downgrade(&self) -> BinaryFrame<'_> {
		BinaryFrame {
			header: self.header.downgrade(),
			data: Cow::Borrowed(&self.data),
		}
	}
}