TaggedFile: Rename take method to remove

This commit is contained in:
Serial 2022-11-09 13:47:21 -05:00 committed by Alex
parent 7fdc3e0b2a
commit e4c0ea5579
2 changed files with 6 additions and 5 deletions

View file

@ -11,8 +11,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- **Files**: Return the removed tag from `<File>::remove(TagType)`
- Previously, the only way to remove and take a tag was through `TaggedFile::take`.
- Previously, the only way to remove and take ownership of a tag was through `TaggedFile::take`.
This was not possible when using a concrete type, such as `OpusFile`.
- **TaggedFile**: Renamed `TaggedFile::take` to `TaggedFile::remove`
## [0.9.0] - 2022-10-30

View file

@ -297,7 +297,7 @@ impl TaggedFile {
/// # let path_to_mp3 = "tests/files/assets/minimal/full_test.mp3";
/// // Read an MP3 file without an ID3v2 tag
/// let mut tagged_file = lofty::read_from_path(path_to_mp3)?;
/// # let _ = tagged_file.take(TagType::ID3v2); // sneaky
/// # let _ = tagged_file.remove(TagType::ID3v2); // sneaky
///
/// assert!(!tagged_file.contains_tag_type(TagType::ID3v2));
///
@ -312,7 +312,7 @@ impl TaggedFile {
let tag_type = tag.tag_type();
if self.supports_tag_type(tag_type) {
let ret = self.take(tag_type);
let ret = self.remove(tag_type);
self.tags.push(tag);
return ret;
@ -336,12 +336,12 @@ impl TaggedFile {
/// assert!(tagged_file.contains_tag_type(TagType::ID3v2));
///
/// // Take the ID3v2 tag
/// let id3v2 = tagged_file.take(TagType::ID3v2);
/// let id3v2 = tagged_file.remove(TagType::ID3v2);
///
/// assert!(!tagged_file.contains_tag_type(TagType::ID3v2));
/// # Ok(()) }
/// ```
pub fn take(&mut self, tag_type: TagType) -> Option<Tag> {
pub fn remove(&mut self, tag_type: TagType) -> Option<Tag> {
self.tags
.iter()
.position(|t| t.tag_type() == tag_type)