Skip to content

Commit 97af374

Browse files
committed
docs: move constructors back to top of rustdoc pages
1 parent 5f51d42 commit 97af374

File tree

7 files changed

+73
-51
lines changed

7 files changed

+73
-51
lines changed

justfile

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
_list:
2+
@just --list
3+
4+
# Lint workspace with Clippy.
5+
clippy:
6+
cargo clippy --workspace --all-targets --no-default-features
7+
cargo clippy --workspace --all-targets --all-features
8+
9+
# Document crates in workspace.
10+
doc *args:
11+
RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace --all-features {{ args }}

src/futures/bufread/generic/decoder.rs

+11-9
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ pin_project! {
2828
}
2929
}
3030

31+
impl<R: AsyncBufRead, D: Decode> Decoder<R, D> {
32+
pub fn new(reader: R, decoder: D) -> Self {
33+
Self {
34+
reader,
35+
decoder,
36+
state: State::Decoding,
37+
multiple_members: false,
38+
}
39+
}
40+
}
41+
3142
impl<R, D> Decoder<R, D> {
3243
pub fn get_ref(&self) -> &R {
3344
&self.reader
@@ -51,15 +62,6 @@ impl<R, D> Decoder<R, D> {
5162
}
5263

5364
impl<R: AsyncBufRead, D: Decode> Decoder<R, D> {
54-
pub fn new(reader: R, decoder: D) -> Self {
55-
Self {
56-
reader,
57-
decoder,
58-
state: State::Decoding,
59-
multiple_members: false,
60-
}
61-
}
62-
6365
fn do_poll_read(
6466
self: Pin<&mut Self>,
6567
cx: &mut Context<'_>,

src/futures/bufread/generic/encoder.rs

+10-8
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ pin_project! {
2626
}
2727
}
2828

29+
impl<R: AsyncBufRead, E: Encode> Encoder<R, E> {
30+
pub fn new(reader: R, encoder: E) -> Self {
31+
Self {
32+
reader,
33+
encoder,
34+
state: State::Encoding,
35+
}
36+
}
37+
}
38+
2939
impl<R, E> Encoder<R, E> {
3040
pub fn get_ref(&self) -> &R {
3141
&self.reader
@@ -49,14 +59,6 @@ impl<R, E> Encoder<R, E> {
4959
}
5060

5161
impl<R: AsyncBufRead, E: Encode> Encoder<R, E> {
52-
pub fn new(reader: R, encoder: E) -> Self {
53-
Self {
54-
reader,
55-
encoder,
56-
state: State::Encoding,
57-
}
58-
}
59-
6062
fn do_poll_read(
6163
self: Pin<&mut Self>,
6264
cx: &mut Context<'_>,

src/tokio/bufread/generic/decoder.rs

+11-9
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,17 @@ pin_project! {
2828
}
2929
}
3030

31+
impl<R: AsyncBufRead, D: Decode> Decoder<R, D> {
32+
pub fn new(reader: R, decoder: D) -> Self {
33+
Self {
34+
reader,
35+
decoder,
36+
state: State::Decoding,
37+
multiple_members: false,
38+
}
39+
}
40+
}
41+
3142
impl<R, D> Decoder<R, D> {
3243
pub fn get_ref(&self) -> &R {
3344
&self.reader
@@ -51,15 +62,6 @@ impl<R, D> Decoder<R, D> {
5162
}
5263

5364
impl<R: AsyncBufRead, D: Decode> Decoder<R, D> {
54-
pub fn new(reader: R, decoder: D) -> Self {
55-
Self {
56-
reader,
57-
decoder,
58-
state: State::Decoding,
59-
multiple_members: false,
60-
}
61-
}
62-
6365
fn do_poll_read(
6466
self: Pin<&mut Self>,
6567
cx: &mut Context<'_>,

src/tokio/bufread/generic/encoder.rs

+10-9
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,16 @@ pin_project! {
2626
}
2727
}
2828

29+
impl<R: AsyncBufRead, E: Encode> Encoder<R, E> {
30+
pub fn new(reader: R, encoder: E) -> Self {
31+
Self {
32+
reader,
33+
encoder,
34+
state: State::Encoding,
35+
}
36+
}
37+
}
38+
2939
impl<R, E> Encoder<R, E> {
3040
pub fn get_ref(&self) -> &R {
3141
&self.reader
@@ -47,16 +57,7 @@ impl<R, E> Encoder<R, E> {
4757
self.reader
4858
}
4959
}
50-
5160
impl<R: AsyncBufRead, E: Encode> Encoder<R, E> {
52-
pub fn new(reader: R, encoder: E) -> Self {
53-
Self {
54-
reader,
55-
encoder,
56-
state: State::Encoding,
57-
}
58-
}
59-
6061
fn do_poll_read(
6162
self: Pin<&mut Self>,
6263
cx: &mut Context<'_>,

src/tokio/write/generic/decoder.rs

+10-8
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ pin_project! {
3030
}
3131
}
3232

33+
impl<W: AsyncWrite, D: Decode> Decoder<W, D> {
34+
pub fn new(writer: W, decoder: D) -> Self {
35+
Self {
36+
writer: BufWriter::new(writer),
37+
decoder,
38+
state: State::Decoding,
39+
}
40+
}
41+
}
42+
3343
impl<W, D> Decoder<W, D> {
3444
pub fn get_ref(&self) -> &W {
3545
self.writer.get_ref()
@@ -49,14 +59,6 @@ impl<W, D> Decoder<W, D> {
4959
}
5060

5161
impl<W: AsyncWrite, D: Decode> Decoder<W, D> {
52-
pub fn new(writer: W, decoder: D) -> Self {
53-
Self {
54-
writer: BufWriter::new(writer),
55-
decoder,
56-
state: State::Decoding,
57-
}
58-
}
59-
6062
fn do_poll_write(
6163
self: Pin<&mut Self>,
6264
cx: &mut Context<'_>,

src/tokio/write/generic/encoder.rs

+10-8
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ pin_project! {
3030
}
3131
}
3232

33+
impl<W: AsyncWrite, E: Encode> Encoder<W, E> {
34+
pub fn new(writer: W, encoder: E) -> Self {
35+
Self {
36+
writer: BufWriter::new(writer),
37+
encoder,
38+
state: State::Encoding,
39+
}
40+
}
41+
}
42+
3343
impl<W, E> Encoder<W, E> {
3444
pub fn get_ref(&self) -> &W {
3545
self.writer.get_ref()
@@ -53,14 +63,6 @@ impl<W, E> Encoder<W, E> {
5363
}
5464

5565
impl<W: AsyncWrite, E: Encode> Encoder<W, E> {
56-
pub fn new(writer: W, encoder: E) -> Self {
57-
Self {
58-
writer: BufWriter::new(writer),
59-
encoder,
60-
state: State::Encoding,
61-
}
62-
}
63-
6466
fn do_poll_write(
6567
self: Pin<&mut Self>,
6668
cx: &mut Context<'_>,

0 commit comments

Comments
 (0)