Mirrors/lofty-rs
2
0
Fork 0
mirror of https://github.com/Serial-ATA/lofty-rs synced 2025-01-05 16:58:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: Update supported FileTypes

Browse source
This commit is contained in:
Serial 2022-06-10 08:21:29 -04:00
parent e62e2c1386
commit 54aee9c996
No known key found for this signature in database
GPG key ID: DA95198DC17C4568
3 changed files with 17 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/ape/tag/mod.rs
View file

@ -56,6 +56,7 @@ macro_rules! impl_accessor {
/// ///
/// * [`FileType::APE`](crate::FileType::APE) /// * [`FileType::APE`](crate::FileType::APE)
/// * [`FileType::MP3`](crate::FileType::MP3) /// * [`FileType::MP3`](crate::FileType::MP3)
/// * [`FileType::WavPack`](crate::FileType::WavPack)
/// ///
/// ## Item storage /// ## Item storage
/// ///

8
src/id3/v1/tag.rs
View file

@ -28,7 +28,7 @@ macro_rules! impl_accessor {
} }
} }
#[derive(Default, Debug, PartialEq, Clone)] #[derive(Default, Debug, PartialEq, Eq, Clone)]
/// An ID3v1 tag /// An ID3v1 tag
/// ///
/// ID3v1 is a severely limited format, with each field /// ID3v1 is a severely limited format, with each field
@ -39,6 +39,12 @@ macro_rules! impl_accessor {
/// Attempting to write a field greater than the maximum size /// Attempting to write a field greater than the maximum size
/// will **not** error, it will just be shrunk. /// will **not** error, it will just be shrunk.
/// ///
/// ## Supported file types
///
/// * [`FileType::APE`](crate::FileType::APE)
/// * [`FileType::MP3`](crate::FileType::MP3)
/// * [`FileType::WavPack`](crate::FileType::WavPack)
///
/// ## Conversions /// ## Conversions
/// ///
/// ### From `Tag` /// ### From `Tag`

11
src/ogg/tag.rs
View file

@ -1,5 +1,6 @@
use crate::error::{ErrorKind, LoftyError, Result}; use crate::error::{ErrorKind, LoftyError, Result};
use crate::file::FileType; use crate::file::FileType;
use crate::flac::write;
use crate::ogg::write::OGGFormat; use crate::ogg::write::OGGFormat;
use crate::picture::{Picture, PictureInformation, PictureType}; use crate::picture::{Picture, PictureInformation, PictureType};
use crate::probe::Probe; use crate::probe::Probe;
@ -7,7 +8,6 @@ use crate::tag::item::{ItemKey, ItemValue, TagItem};
use crate::tag::{Tag, TagType}; use crate::tag::{Tag, TagType};
use crate::traits::{Accessor, TagExt}; use crate::traits::{Accessor, TagExt};
use crate::flac::write;
use std::fs::{File, OpenOptions}; use std::fs::{File, OpenOptions};
use std::io::{Cursor, Write}; use std::io::{Cursor, Write};
use std::path::Path; use std::path::Path;
@ -34,8 +34,15 @@ macro_rules! impl_accessor {
} }
} }
#[derive(Default, PartialEq, Debug, Clone)] #[derive(Default, PartialEq, Eq, Debug, Clone)]
/// Vorbis comments /// Vorbis comments
///
/// ## Supported file types
///
/// * [`FileType::FLAC`](crate::FileType::FLAC)
/// * [`FileType::Opus`](crate::FileType::Opus)
/// * [`FileType::Speex`](crate::FileType::Speex)
/// * [`FileType::Vorbis`](crate::FileType::Vorbis)
pub struct VorbisComments { pub struct VorbisComments {
/// An identifier for the encoding software /// An identifier for the encoding software
pub(crate) vendor: String, pub(crate) vendor: String,