Serial-ATA/lofty-rs

Document that `remove_<tag>` and `TagType::remove_from` are not equivalent

Open

#610 opened on Feb 14, 2026

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Rust (72 forks)auto 404
docsgood first issue

Repository metrics

Stars
 (342 stars)
PR merge metrics
 (PR metrics pending)

Description

<File>::remove_<tag> will only remove the tag in memory, it does not affect the final write. TagType::remove_from() will remove the tag on disk.

For example:

let mut file = File::open("foo.flac").unwrap();
let mut flac = FlacFile::read_from(&mut file).unwrap();
flac.remove_id3v2();

Will remove the tag from the FlacFile. That's useful if the tags from the FlacFile need to be copied to another file, without first needing to strip the ID3v2 tags from it.

TagType::Id3v2.remove_from_path("foo.flac").unwrap();

// or

let mut file = File::open("foo.flac").unwrap();
TagType::Id3v2.remove_from(&mut file).unwrap();

This is what actually removes the ID3v2 tag on disk.

Contributor guide

Research direction
Investigate the two methods to document their behavioral differences clearly.
Tech stack
rust
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85