how best to skip comments?
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
Research direction
Start by reading the Reader event APIs and the comment handling paths in the repository; the issue does not name files or tests. Compare buffered and unbuffered reading to identify a pattern for skipping comment events, then check whether the approach preserves the reader’s input and buffer constraints. Done means providing a workable way to ignore comments during buffered reading.
Written by the indexing model from the issue text.
Description
I'm looking at porting some applications from xml-rs to quick-xml, and one of the blockers I've hit is that quick_xml doesn't have a way to quickly strip all comments (à la xml-rs's ParserConfig::ignore_comments(true)).
A wrapper function like
fn read_event<'a, 'b, R: BufRead>(
reader: &'a mut Reader<R>,
buf: &'b mut Vec<u8>,
) -> Result<Event<'b>> {
loop {
let event = reader.read_event(buf)?;
if !matches!(event, Event::Comment(_)) {
return Ok(event);
}
}
}
seems appealing but of course doesn't work because of our friend
`*buf` was mutably borrowed here in the previous iteration of the loop
Switching to read_event_unbuffered and requiring the input to be &[u8] works but isn't ideal.
Are there any good patterns for ignoring comments?
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 299
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 9
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from tafia/quick-xml
-
Parser accepts an empty element or attribute namePossibly taken @ychampion claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
DecodingReader::set_encoding panics when the XML declaration is longer than 64 bytesPossibly taken @emschwartz claimed this 4 days ago. Openbug encoding
Difficulty 4/5 3-5 days Newbie friendliness 30/100
tafia/quick-xml#1040 · 1 comment ·
Maintainers usually reply within 1 day
-
encoding optimization
Difficulty 4/5 3-5 days Newbie friendliness 55/100
tafia/quick-xml#1039 · 1 comment ·
Maintainers usually reply within 1 day
-
optimization question
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 1-2 days Newbie friendliness 53/100
tafia/quick-xml#1035 · 1 comment ·
Maintainers usually reply within 1 day
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
storytold/photocraft#14822 ·
Maintainers usually reply within 1 day
-
bug css
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
dginev/latexml-oxide#853 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
[Bug] export_build_environment admits its output directory only after the export ran in the build computerPossibly taken @viniciusdsandrade claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day