Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write document of StreamWriter::finish #419

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Write document of StreamWriter::finish #419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/encoder.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1525,6 +1525,12 @@ impl<'a, W: Write> StreamWriter<'a, W> {
}
}

/// Consume the stream writer with validation.
///
/// Unlike a simple drop this ensures that the all data was written correctly. When other
/// validation options (chunk sequencing) had been turned on in the configuration of inner
/// [`Writer`], then it will also do a check on their correctness. Differently from
/// [`Writer::finish`], this just `flush`es, returns error if some data is abandoned.
pub fn finish(mut self) -> Result<()> {
if self.to_write > 0 {
let err = FormatErrorKind::MissingData(self.to_write).into();
Expand Down
Loading