forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(lib): add links to main modules

Browse Source
This commit is contained in:
Sean McArthur
2015-04-22 12:27:33 -07:00
parent 6fad307753
commit 8198f41ec0
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib.rs
View File

@@ -9,8 +9,9 @@
//! is a low-level typesafe abstraction over raw HTTP, providing an elegant //! is a low-level typesafe abstraction over raw HTTP, providing an elegant
//! layer over "stringly-typed" HTTP. //! layer over "stringly-typed" HTTP.
//! //!
//! Hyper offers both an HTTP/S client an HTTP server which can be used to drive //! Hyper offers both a [Client](client/index.html) and a
//! complex web applications written entirely in Rust. //! [Server](server/index.html) which can be used to drive complex web
//! applications written entirely in Rust.
//! //!
//! ## Internal Design //! ## Internal Design
//! //!
@@ -20,8 +21,8 @@
//! //!
//! ### Common Functionality //! ### Common Functionality
//! //!
//! Functionality and code shared between the Server and Client implementations can //! Functionality and code shared between the Server and Client implementations
//! be found in `src` directly - this includes `NetworkStream`s, `Method`s, //! can be found in `src` directly - this includes `NetworkStream`s, `Method`s,
//! `StatusCode`, and so on. //! `StatusCode`, and so on.
//! //!
//! #### Methods //! #### Methods
@@ -38,7 +39,8 @@
//! //!
//! #### Headers //! #### Headers
//! //!
//! Hyper's header representation is likely the most complex API exposed by Hyper. //! Hyper's [header](header/index.html) representation is likely the most
//! complex API exposed by Hyper.
//! //!
//! Hyper's headers are an abstraction over an internal `HashMap` and provides a //! Hyper's headers are an abstraction over an internal `HashMap` and provides a
//! typesafe API for interacting with headers that does not rely on the use of //! typesafe API for interacting with headers that does not rely on the use of