summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoseph Birr-Pixton <jpixton@gmail.com>2021-07-04 11:42:58 +0100
committerJoseph Birr-Pixton <jpixton@gmail.com>2021-07-04 11:42:58 +0100
commit999050b4c8d934bd3fa319fe98c344267e663e5c (patch)
tree06dd849bd33dfd3d6eec3c0941466529c8c2ebc0
parent90f0de6aa91593c4e66b6215ad981bee6a1646f0 (diff)
Mention in builder docs other design goalv/0.20.0-beta1
-rw-r--r--rustls/src/builder.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/rustls/src/builder.rs b/rustls/src/builder.rs
index f6753f07..9b7cb67e 100644
--- a/rustls/src/builder.rs
+++ b/rustls/src/builder.rs
@@ -5,12 +5,16 @@ use crate::versions;
use std::marker::PhantomData;
-/// Building a [`ServerConfig`] or [`ClientConfig`] in a linker-friendly way.
+/// Building a [`ServerConfig`] or [`ClientConfig`] in a linker-friendly and
+/// complete way.
///
/// Linker-friendly: meaning unused cipher suites, protocol
/// versions, key exchange mechanisms, etc. can be discarded
/// by the linker as they'll be unreferenced.
///
+/// Complete: the type system ensures all decisions required to run a
+/// server or client have been made by the time the process finishes.
+///
/// Example, to make a [`ServerConfig`]:
///
/// ```no_run