asp/keep
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: remove redundant rustdoc comments for structs

Browse Source 
Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
Andrew Phillips
2025-09-10 14:05:53 -03:00
parent 6cff3bd165
commit ce9b823e17
1 changed files with 0 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/compression_engine/gzip.rs
View File

@@ -26,20 +26,6 @@ use flate2::write::GzEncoder;
use crate::compression_engine::CompressionEngine;
```rust
/// GZip compression engine implementation.
///
/// This struct provides the functionality to compress and decompress data using
/// the GZip algorithm. It implements the `CompressionEngine` trait for integration
/// with the compression service.
///
/// # Examples
///
/// ```rust
/// let engine = keep::compression_engine::get_compression_engine(keep::compression_engine::CompressionType::GZip)
/// .expect("Failed to get GZip engine");
/// assert!(engine.is_supported());
/// ```
#[derive(Debug, Eq, PartialEq, Clone, Default)]
pub struct CompressionEngineGZip {}
@@ -142,20 +128,6 @@ impl CompressionEngine for CompressionEngineGZip {
}
}
```rust
/// Auto-finishing GZip encoder that automatically calls finish on drop.
///
/// This wrapper ensures that the GZip stream is properly closed even if the
/// writer is dropped unexpectedly, preventing incomplete compression files.
///
/// # Examples
///
/// ```rust
/// let file = File::create("test.gz").unwrap();
/// let encoder = GzEncoder::new(file, Compression::default());
/// let auto_encoder = AutoFinishGzEncoder::new(encoder);
/// // Encoder will finish on drop
/// ```
pub struct AutoFinishGzEncoder<W: Write> {
encoder: Option<GzEncoder<W>>,
}