Skip to content

Commit 631501b

Browse files
NobodyXuNobodyXu
authored
Re-export compression_codecs as codecs (#368)
1 parent 016a857 commit 631501b

File tree

18 files changed

+65
-65
lines changed

18 files changed

+65
-65
lines changed

‎src/futures/bufread/generic/decoder.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use crate::codec::Decode;
1+
use crate::codecs::Decode;
22
use crate::core::util::PartialBuffer;
33

44
use core::{

‎src/futures/bufread/generic/encoder.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use core::{
44
};
55
use std::io::Result;
66

7-
use crate::codec::Encode;
7+
use crate::codecs::Encode;
88
use crate::core::util::PartialBuffer;
99
use futures_core::ready;
1010
use futures_io::{AsyncBufRead, AsyncRead, AsyncWrite, IoSlice};

‎src/futures/bufread/macros/decoder.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ macro_rules! decoder {
88
#[derive(Debug)]
99
pub struct $name<$inner> {
1010
#[pin]
11-
inner: crate::futures::bufread::Decoder<$inner, crate::codec::$name>,
11+
inner: crate::futures::bufread::Decoder<$inner, crate::codecs::$name>,
1212
}
1313
}
1414

@@ -17,13 +17,13 @@ macro_rules! decoder {
1717
/// emit an uncompressed stream.
1818
pub fn new(read: $inner) -> $name<$inner> {
1919
$name {
20-
inner: crate::futures::bufread::Decoder::new(read, crate::codec::$name::new()),
20+
inner: crate::futures::bufread::Decoder::new(read, crate::codecs::$name::new()),
2121
}
2222
}
2323

2424
/// Creates a new decoder with the given codec, which will read compressed data from the given stream and
2525
/// emit an uncompressed stream.
26-
pub fn with_codec(read: $inner, codec: crate::codec::$name) -> $name<$inner> {
26+
pub fn with_codec(read: $inner, codec: crate::codecs::$name) -> $name<$inner> {
2727
$name {
2828
inner: crate::futures::bufread::Decoder::new(read, codec)
2929
}

‎src/futures/bufread/macros/encoder.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ macro_rules! encoder {
88
#[derive(Debug)]
99
pub struct $name<$inner> {
1010
#[pin]
11-
inner: crate::futures::bufread::Encoder<$inner, crate::codec::$name>,
11+
inner: crate::futures::bufread::Encoder<$inner, crate::codecs::$name>,
1212
}
1313
}
1414

@@ -22,7 +22,7 @@ macro_rules! encoder {
2222

2323
/// Creates a new encoder with the given codec, which will read uncompressed data from the given stream
2424
/// and emit an compressed stream.
25-
pub fn with_codec(read: $inner, codec: crate::codec::$name) -> $name<$inner> {
25+
pub fn with_codec(read: $inner, codec: crate::codecs::$name) -> $name<$inner> {
2626
$name {
2727
inner: crate::futures::bufread::Encoder::new(read, codec)
2828
}

‎src/futures/write/generic/decoder.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
use crate::codec::Decode;
1+
use crate::codecs::Decode;
22
use crate::core::util::PartialBuffer;
33
use crate::futures::write::{AsyncBufWrite, BufWriter};
44
use futures_core::ready;

‎src/futures/write/generic/encoder.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use std::{
44
task::{Context, Poll},
55
};
66

7-
use crate::codec::Encode;
7+
use crate::codecs::Encode;
88
use crate::core::util::PartialBuffer;
99
use crate::futures::write::{AsyncBufWrite, BufWriter};
1010
use futures_core::ready;

‎src/futures/write/macros/decoder.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ macro_rules! decoder {
88
#[derive(Debug)]
99
pub struct $name<$inner> {
1010
#[pin]
11-
inner: crate::futures::write::Decoder<$inner, crate::codec::$name>,
11+
inner: crate::futures::write::Decoder<$inner, crate::codecs::$name>,
1212
}
1313
}
1414

@@ -17,13 +17,13 @@ macro_rules! decoder {
1717
/// to the given stream.
1818
pub fn new(read: $inner) -> $name<$inner> {
1919
$name {
20-
inner: crate::futures::write::Decoder::new(read, crate::codec::$name::new()),
20+
inner: crate::futures::write::Decoder::new(read, crate::codecs::$name::new()),
2121
}
2222
}
2323

2424
/// Creates a new decoder with the given codec, which will take in compressed data and write it, uncompressed,
2525
/// to the given stream.
26-
pub fn with_codec(read: $inner, codec: crate::codec::$name) -> $name<$inner> {
26+
pub fn with_codec(read: $inner, codec: crate::codecs::$name) -> $name<$inner> {
2727
$name {
2828
inner: crate::futures::write::Decoder::new(read, codec)
2929
}

‎src/futures/write/macros/encoder.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ macro_rules! encoder {
88
#[derive(Debug)]
99
pub struct $name<$inner> {
1010
#[pin]
11-
inner: crate::futures::write::Encoder<$inner, crate::codec::$name>,
11+
inner: crate::futures::write::Encoder<$inner, crate::codecs::$name>,
1212
}
1313
}
1414

@@ -22,7 +22,7 @@ macro_rules! encoder {
2222

2323
/// Creates a new encoder with the given codec, which will take in uncompressed data and write it
2424
/// compressed to the given stream.
25-
pub fn with_codec(read: $inner, codec: crate::codec::$name) -> $name<$inner> {
25+
pub fn with_codec(read: $inner, codec: crate::codecs::$name) -> $name<$inner> {
2626
$name {
2727
inner: crate::futures::write::Encoder::new(read, codec)
2828
}

‎src/lib.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,16 +160,16 @@ pub mod futures;
160160
#[cfg(feature = "tokio")]
161161
pub mod tokio;
162162

163-
pub use compression_codecs as codec;
163+
pub use compression_codecs as codecs;
164164
pub use compression_core as core;
165165

166166
pub use core::Level;
167167

168168
#[cfg(feature = "zstd")]
169-
pub use codec::zstd::params as zstd;
169+
pub use codecs::zstd::params as zstd;
170170

171171
#[cfg(feature = "lz4")]
172-
pub use codec::lz4::params as lz4;
172+
pub use codecs::lz4::params as lz4;
173173

174174
#[cfg(feature = "brotli")]
175-
pub use codec::brotli::params as brotli;
175+
pub use codecs::brotli::params as brotli;

‎src/macros.rs‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ macro_rules! algos {
4444
{ @enc
4545
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
4646
// let params = brotli::enc::backward_references::BrotliEncoderParams::default();
47-
let params = crate::codec::brotli::params::EncoderParams::default();
47+
let params = crate::codecs::brotli::params::EncoderParams::default();
4848
let params = params.quality(level);
4949
Self {
5050
inner: crate::$($mod::)+generic::Encoder::new(
5151
inner,
52-
crate::codec::BrotliEncoder::new(params),
52+
crate::codecs::BrotliEncoder::new(params),
5353
),
5454
}
5555
}
@@ -58,12 +58,12 @@ macro_rules! algos {
5858
/// will read uncompressed data from the given stream and emit a compressed stream.
5959
pub fn with_params(
6060
inner: $inner,
61-
params: crate::codec::brotli::params::EncoderParams,
61+
params: crate::codecs::brotli::params::EncoderParams,
6262
) -> Self {
6363
Self {
6464
inner: crate::$($mod::)+generic::Encoder::new(
6565
inner,
66-
crate::codec::BrotliEncoder::new(params),
66+
crate::codecs::BrotliEncoder::new(params),
6767
),
6868
}
6969
}
@@ -75,11 +75,11 @@ macro_rules! algos {
7575
{ @enc
7676

7777
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
78-
let params = crate::codec::bzip2::params::Bzip2EncoderParams::from(level);
78+
let params = crate::codecs::bzip2::params::Bzip2EncoderParams::from(level);
7979
Self {
8080
inner: crate::$($mod::)+generic::Encoder::new(
8181
inner,
82-
crate::codec::BzEncoder::new(params, 0),
82+
crate::codecs::BzEncoder::new(params, 0),
8383
),
8484
}
8585
}
@@ -90,12 +90,12 @@ macro_rules! algos {
9090
algos!(@algo deflate ["deflate"] DeflateDecoder DeflateEncoder <$inner>
9191
{ @enc
9292
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
93-
let mut params = crate::codec::flate::params::FlateEncoderParams::from(level);
93+
let mut params = crate::codecs::flate::params::FlateEncoderParams::from(level);
9494

9595
Self {
9696
inner: crate::$($mod::)+generic::Encoder::new(
9797
inner,
98-
crate::codec::DeflateEncoder::new(params),
98+
crate::codecs::DeflateEncoder::new(params),
9999
),
100100
}
101101
}
@@ -121,11 +121,11 @@ macro_rules! algos {
121121
{ @enc
122122

123123
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
124-
let params = crate::codec::flate::params::FlateEncoderParams::from(level);
124+
let params = crate::codecs::flate::params::FlateEncoderParams::from(level);
125125
Self {
126126
inner: crate::$($mod::)+generic::Encoder::new(
127127
inner,
128-
crate::codec::GzipEncoder::new(params),
128+
crate::codecs::GzipEncoder::new(params),
129129
),
130130
}
131131
}
@@ -136,11 +136,11 @@ macro_rules! algos {
136136
algos!(@algo zlib ["zlib"] ZlibDecoder ZlibEncoder <$inner>
137137
{ @enc
138138
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
139-
let params = crate::codec::flate::params::FlateEncoderParams::from(level);
139+
let params = crate::codecs::flate::params::FlateEncoderParams::from(level);
140140
Self {
141141
inner: crate::$($mod::)+generic::Encoder::new(
142142
inner,
143-
crate::codec::ZlibEncoder::new(params),
143+
crate::codecs::ZlibEncoder::new(params),
144144
),
145145
}
146146
}
@@ -162,11 +162,11 @@ macro_rules! algos {
162162
{ @enc
163163

164164
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
165-
let params = crate::codec::zstd::params::CParameter::quality(level);
165+
let params = crate::codecs::zstd::params::CParameter::quality(level);
166166
Self {
167167
inner: crate::$($mod::)+generic::Encoder::new(
168168
inner,
169-
crate::codec::ZstdEncoder::new(params),
169+
crate::codecs::ZstdEncoder::new(params),
170170
),
171171
}
172172
}
@@ -179,16 +179,16 @@ macro_rules! algos {
179179
/// Panics if this function is called with a [`CParameter::nb_workers()`] parameter and
180180
/// the `zstdmt` crate feature is _not_ enabled.
181181
///
182-
/// [`CParameter::nb_workers()`]: crate::codec::zstd::params::CParameter
182+
/// [`CParameter::nb_workers()`]: crate::codecs::zstd::params::CParameter
183183
//
184184
// TODO: remove panic note on next breaking release, along with `CParameter::nb_workers`
185185
// change
186-
pub fn with_quality_and_params(inner: $inner, level: crate::core::Level, params: &[crate::codec::zstd::params::CParameter]) -> Self {
187-
let level = crate::codec::zstd::params::CParameter::quality(level);
186+
pub fn with_quality_and_params(inner: $inner, level: crate::core::Level, params: &[crate::codecs::zstd::params::CParameter]) -> Self {
187+
let level = crate::codecs::zstd::params::CParameter::quality(level);
188188
Self {
189189
inner: crate::$($mod::)+generic::Encoder::new(
190190
inner,
191-
crate::codec::ZstdEncoder::new_with_params(level, params),
191+
crate::codecs::ZstdEncoder::new_with_params(level, params),
192192
),
193193
}
194194
}
@@ -204,23 +204,23 @@ macro_rules! algos {
204204
///
205205
/// Returns error when `dictionary` is not valid.
206206
pub fn with_dict(inner: $inner, level: crate::core::Level, dictionary: &[u8]) -> ::std::io::Result<Self> {
207-
let level = crate::codec::zstd::params::CParameter::quality(level);
207+
let level = crate::codecs::zstd::params::CParameter::quality(level);
208208
Ok(Self {
209209
inner: crate::$($mod::)+generic::Encoder::new(
210210
inner,
211-
crate::codec::ZstdEncoder::new_with_dict(level, dictionary)?,
211+
crate::codecs::ZstdEncoder::new_with_dict(level, dictionary)?,
212212
),
213213
})
214214
}
215215
}
216216
{ @dec
217217
/// Creates a new decoder, using the specified parameters, which will read compressed
218218
/// data from the given stream and emit a decompressed stream.
219-
pub fn with_params(inner: $inner, params: &[crate::codec::zstd::params::DParameter]) -> Self {
219+
pub fn with_params(inner: $inner, params: &[crate::codecs::zstd::params::DParameter]) -> Self {
220220
Self {
221221
inner: crate::$($mod::)+generic::Decoder::new(
222222
inner,
223-
crate::codec::ZstdDecoder::new_with_params(params),
223+
crate::codecs::ZstdDecoder::new_with_params(params),
224224
),
225225
}
226226
}
@@ -240,7 +240,7 @@ macro_rules! algos {
240240
Ok(Self {
241241
inner: crate::$($mod::)+generic::Decoder::new(
242242
inner,
243-
crate::codec::ZstdDecoder::new_with_dict(dictionary)?,
243+
crate::codecs::ZstdDecoder::new_with_dict(dictionary)?,
244244
),
245245
})
246246
}
@@ -254,7 +254,7 @@ macro_rules! algos {
254254
Self {
255255
inner: crate::$($mod::)+generic::Encoder::new(
256256
inner,
257-
crate::codec::XzEncoder::new(level),
257+
crate::codecs::XzEncoder::new(level),
258258
),
259259
}
260260
}
@@ -267,7 +267,7 @@ macro_rules! algos {
267267
Self {
268268
inner: crate::$($mod::)+generic::Encoder::new(
269269
inner,
270-
crate::codec::XzEncoder::parallel(threads, level),
270+
crate::codecs::XzEncoder::parallel(threads, level),
271271
),
272272
}
273273
}
@@ -282,7 +282,7 @@ macro_rules! algos {
282282
Self {
283283
inner: crate::$($mod::)+generic::Decoder::new(
284284
read,
285-
crate::codec::XzDecoder::with_memlimit(memlimit),
285+
crate::codecs::XzDecoder::with_memlimit(memlimit),
286286
),
287287
}
288288
}
@@ -295,7 +295,7 @@ macro_rules! algos {
295295
Self {
296296
inner: crate::$($mod::)+generic::Decoder::new(
297297
read,
298-
crate::codec::XzDecoder::parallel(threads, usize::MAX.try_into().unwrap()),
298+
crate::codecs::XzDecoder::parallel(threads, usize::MAX.try_into().unwrap()),
299299
),
300300
}
301301
}
@@ -310,7 +310,7 @@ macro_rules! algos {
310310
Self {
311311
inner: crate::$($mod::)+generic::Decoder::new(
312312
read,
313-
crate::codec::XzDecoder::parallel(threads, memlimit),
313+
crate::codecs::XzDecoder::parallel(threads, memlimit),
314314
),
315315
}
316316
}
@@ -321,7 +321,7 @@ macro_rules! algos {
321321
{ @enc
322322

323323
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
324-
let encoder = crate::codec::LzmaEncoder::new(level);
324+
let encoder = crate::codecs::LzmaEncoder::new(level);
325325
let inner = crate::$($mod::)+generic::Encoder::new(inner, encoder);
326326
Self {
327327
inner
@@ -338,7 +338,7 @@ macro_rules! algos {
338338
Self {
339339
inner: crate::$($mod::)+generic::Decoder::new(
340340
read,
341-
crate::codec::LzmaDecoder::with_memlimit(memlimit),
341+
crate::codecs::LzmaDecoder::with_memlimit(memlimit),
342342
),
343343
}
344344
}
@@ -350,18 +350,18 @@ macro_rules! algos {
350350
{ @enc
351351

352352
pub fn with_quality(inner: $inner, level: crate::core::Level) -> Self {
353-
Self::with_quality_and_params(inner, level, crate::codec::lz4::params::EncoderParams::default())
353+
Self::with_quality_and_params(inner, level, crate::codecs::lz4::params::EncoderParams::default())
354354
}
355355

356356
/// Creates a new encoder, using the specified compression level and parameters, which
357357
/// will read uncompressed data from the given stream and emit a compressed stream.
358358
pub fn with_quality_and_params(
359359
inner: $inner,
360360
level: crate::core::Level,
361-
mut params: crate::codec::lz4::params::EncoderParams,
361+
mut params: crate::codecs::lz4::params::EncoderParams,
362362
) -> Self {
363363
let params = params.level(level);
364-
let encoder = crate::codec::Lz4Encoder::new(params);
364+
let encoder = crate::codecs::Lz4Encoder::new(params);
365365
let cap = encoder.buffer_size();
366366
Self {
367367
inner: crate::$($mod::)+generic::Encoder::with_capacity(

0 commit comments

Comments
 (0)