docs: remove redundant rustdoc comments for structs
Co-authored-by: aider (openai/andrew/openrouter/sonoma-sky-alpha) <aider@aider.chat>
This commit is contained in:
@@ -26,20 +26,6 @@ use flate2::write::GzEncoder;
|
|||||||
|
|
||||||
use crate::compression_engine::CompressionEngine;
|
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)]
|
#[derive(Debug, Eq, PartialEq, Clone, Default)]
|
||||||
pub struct CompressionEngineGZip {}
|
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> {
|
pub struct AutoFinishGzEncoder<W: Write> {
|
||||||
encoder: Option<GzEncoder<W>>,
|
encoder: Option<GzEncoder<W>>,
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user