Skip to content

Commit ce27cc0

Browse files
ijacksonmatthiasbeyer
authored andcommitted
Delete docs for vestigial AsyncConfigBuilder
This struct seems to be a remnant of a previous approach to async. It cannot be used, and the documentation was lies. There isn't a `build` method. There are, in fact, no methods at all. Signed-off-by: Ian Jackson <[email protected]> Signed-off-by: Matthias Beyer <[email protected]>
1 parent e95b9dd commit ce27cc0

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

src/builder.rs

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -103,23 +103,17 @@ pub struct DefaultState {
103103
sources: Vec<Box<dyn Source + Send + Sync>>,
104104
}
105105

106-
/// The asynchronous configuration builder.
107-
///
108-
/// Similar to a [`ConfigBuilder`] it maintains a set of defaults, a set of sources, and overrides.
109-
///
110-
/// Defaults do not override anything, sources override defaults, and overrides override anything else.
111-
/// Within those three groups order of adding them at call site matters - entities added later take precedence.
112-
///
113-
/// For more detailed description and examples see [`ConfigBuilder`].
114-
/// [`AsyncConfigBuilder`] is just an extension of it that takes async functions into account.
115-
///
116-
/// To obtain a [`Config`] call [`build`](AsyncConfigBuilder::build) or [`build_cloned`](AsyncConfigBuilder::build_cloned)
117-
///
118-
/// # Example
119-
/// Since this library does not implement any [`AsyncSource`] an example in rustdocs cannot be given.
120-
/// Detailed explanation about why such a source is not implemented is in [`AsyncSource`]'s documentation.
121-
///
122-
/// Refer to [`ConfigBuilder`] for similar API sample usage or to the examples folder of the crate, where such a source is implemented.
106+
// Dummy useless struct
107+
//
108+
// This struct exists only to avoid the semver break
109+
// which would be implied by removing it.
110+
//
111+
// This struct cannot be used for anything useful.
112+
// (Nor can it be extended without a semver break, either.)
113+
//
114+
// In a future release, we should have
115+
// type AsyncConfigBuilder = ConfigBuilder<AsyncState>;
116+
#[doc(hidden)]
123117
#[derive(Debug, Clone, Default)]
124118
pub struct AsyncConfigBuilder {}
125119

0 commit comments

Comments
 (0)