Explorar o código

Document the loopback.

whitequark %!s(int64=7) %!d(string=hai) anos
pai
achega
c5fc8f7da7
Modificáronse 1 ficheiros con 8 adicións e 5 borrados
  1. 8 5
      src/phy/mod.rs

+ 8 - 5
src/phy/mod.rs

@@ -1,12 +1,15 @@
 //! Access to networking hardware.
 //!
 //! The `phy` module deals with the *network devices*. It provides a trait
-//! for transmitting and receiving frames, [Device](trait.Device.html),
-//! as well as an implementations of that trait that uses the host OS,
-//! [RawSocket](struct.RawSocket.html) and [TapInterface](struct.TapInterface.html).
+//! for transmitting and receiving frames, [Device](trait.Device.html)
+//! and implementations of it:
 //!
-//! It also provides the _middleware interfaces_ [Tracer](struct.Tracer.html) and
-//! [FaultInjector](struct.FaultInjector.html), to facilitate debugging.
+//!   * the [_loopback_](struct.Loopback.html), for zero dependency testing;
+//!   * _middleware_ [Tracer](struct.Tracer.html) and
+//!     [FaultInjector](struct.FaultInjector.html), to facilitate debugging;
+//!   * _adapters_ [RawSocket](struct.RawSocket.html) and
+//!     [TapInterface](struct.TapInterface.html), to transmit and receive frames
+//!     on the host OS.
 //!
 // https://github.com/rust-lang/rust/issues/38740
 //! <h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>