Remove the ability to use un-buffered functions with Reader<&[u8]> #440
Conversation
Codecov Report
@@ Coverage Diff @@
## master #440 +/- ##
==========================================
+ Coverage 51.15% 51.27% +0.11%
==========================================
Files 27 27
Lines 13314 13289 -25
==========================================
+ Hits 6811 6814 +3
+ Misses 6503 6475 -28
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
In the near future, decoding will be performed automatically as the input is read. If the input has an unknown encoding, it must be decoded first, necessitating a buffer. Therefore only the buffered implementation can be used for `Reader::from_bytes()`
| /// Deserialize an instance of type `T` from bytes of XML text. | ||
| pub fn from_slice<'de, T>(s: &'de [u8]) -> Result<T, DeError> | ||
| where | ||
| T: Deserialize<'de>, | ||
| { | ||
| let mut de = Deserializer::from_slice(s); | ||
| T::deserialize(&mut de) | ||
| } | ||
|
|
There was a problem hiding this comment.
Still, the constructors were probably deleted in vain. What do they interfere with? It's still may be valuable to pass a byte array and allow quick_xml to detect encoding and parse it. If encoding is UTF-8, then borrowing is possible. @dralley, what do you think?
If it remains removed, then it is needed to fix dangling documentation links
There was a problem hiding this comment.
re: documention, whoops, yes, I can fix that
re: constructors, IMO it is unnecessary, this is why we have the decoding functions as separate now. It's only an extra line or two of code and if we made a constructor which included that line it would need to be falliable and return Result, unlike the others.
There was a problem hiding this comment.
We should make the CI fail on documentation issues if possible ^^
One is a dangling reference from tafia#440 The others fixed by converting interlink to HTML link, because rustdoc doesn't understand interlinks to realized trait methods
One is a dangling reference from #440 The others fixed by converting interlink to HTML link, because rustdoc doesn't understand interlinks to realized trait methods
No description provided.