Rename crate

Because tuntap is obviously taken by something rotten, unmaintained and
dead.

Author: vorner

Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "tuntap"
+name = "tun-tap"
 # Also don't forget to update the version in the html_root_url attribute in src/lib.rs
 version = "0.1.0"
 authors = ["Michal 'vorner' Vaner <vorner@vorner.cz>"]

examples/dump_iface.rs

@@ -4,11 +4,11 @@
 //! raw data of the packets that arrive.
 //!
 //! You really do want better error handling than all these unwraps.
-extern crate tuntap;
+extern crate tun_tap;
 
 use std::process::Command;
 
-use tuntap::{Iface, Mode};
+use tun_tap::{Iface, Mode};
 
 /// Run a shell command. Panic if it fails in any way.
 fn cmd(cmd: &str, args: &[&str]) {

examples/pingpong.rs

@@ -8,14 +8,14 @@
 //!
 //! You really do want better error handling than all these unwraps.
 
-extern crate tuntap;
+extern crate tun_tap;
 
 use std::process::Command;
 use std::sync::Arc;
 use std::thread;
 use std::time::Duration;
 
-use tuntap::{Iface, Mode};
+use tun_tap::{Iface, Mode};
 
 /// The packet data. Note that it is prefixed by 4 bytes ‒ two bytes are flags, another two are
 /// protocol. 8, 0 is IPv4, 134, 221 is IPv6. <https://en.wikipedia.org/wiki/EtherType#Examples>.

examples/tokio.rs

@@ -10,15 +10,15 @@
 
 extern crate futures;
 extern crate tokio_core;
-extern crate tuntap;
+extern crate tun_tap;
 
 use std::process::Command;
 use std::time::Duration;
 
 use futures::{Future, Stream};
 use tokio_core::reactor::{Core, Interval};
-use tuntap::{Iface, Mode};
-use tuntap::async::Async;
+use tun_tap::{Iface, Mode};
+use tun_tap::async::Async;
 
 /// The packet data. Note that it is prefixed by 4 bytes ‒ two bytes are flags, another two are
 /// protocol. 8, 0 is IPv4, 134, 221 is IPv6. <https://en.wikipedia.org/wiki/EtherType#Examples>.

examples/vpn.rs

@@ -14,7 +14,7 @@
 
 extern crate futures;
 extern crate tokio_core;
-extern crate tuntap;
+extern crate tun_tap;
 
 use std::env;
 use std::io::Result;
@@ -24,8 +24,8 @@ use futures::{Future, Stream};
 use tokio_core::net::{UdpCodec, UdpSocket};
 use tokio_core::reactor::Core;
 
-use tuntap::{Iface, Mode};
-use tuntap::async::Async;
+use tun_tap::{Iface, Mode};
+use tun_tap::async::Async;
 
 struct VecCodec(SocketAddr);
 

src/async.rs

@@ -67,6 +67,26 @@ impl Async {
     /// # Errors
     ///
     /// This fails with an error in case of low-level OS errors (they shouldn't usually happen).
+    ///
+    /// # Examples
+    ///
+    /// ```rust,no_run
+    /// # extern crate futures;
+    /// # extern crate tokio_core;
+    /// # extern crate tun_tap;
+    /// # use futures::Stream;
+    /// # use tun_tap::*;
+    /// # use tun_tap::async::*;
+    /// # use tokio_core::reactor::Core;
+    /// # fn main() {
+    /// let iface = Iface::new("mytun%d", Mode::Tun).unwrap();
+    /// let name = iface.name().to_owned();
+    /// // Bring the interface up by `ip addr add IP dev $name; ip link set up dev $name`
+    /// let mut core = Core::new().unwrap();
+    /// let async = Async::new(iface, &core.handle()).unwrap();
+    /// let (sink, stream) = async.split();
+    /// # }
+    /// ```
     pub fn new(iface: Iface, handle: &Handle) -> Result<Self> {
         let fd = iface.as_raw_fd();
         let mut nonblock: c_int = 1;

src/lib.rs

@@ -1,12 +1,12 @@
-#![doc(html_root_url = "https://docs.rs/tuntap/0.1.0/tuntap/")]
+#![doc(html_root_url = "https://docs.rs/tun-tap/0.1.0/tun-tap/")]
 #![warn(missing_docs)]
 
 //! A TUN/TAP bindings for Rust.
 //!
 //! This is a basic interface to create userspace virtual network adapter.
 //!
 //! For basic usage, create an [`Iface`](struct.Iface.html) object and call the
-//! [`send`](struct.Iface.html#method.send) and [`recv`](struct.Iface.hmtl#method.recv) methods.
+//! [`send`](struct.Iface.html#method.send) and [`recv`](struct.Iface.html#method.recv) methods.
 //!
 //! You can also use [`Async`](async/struct.Async.html) if you want to integrate with tokio event
 //! loop. This is configurable by a feature (it is on by default).
@@ -85,7 +85,7 @@ impl Iface {
     /// # Examples
     ///
     /// ```rust,no_run
-    /// # use tuntap::*;
+    /// # use tun_tap::*;
     /// let iface = Iface::new("mytun", Mode::Tun).expect("Failed to create a TUN device");
     /// let name = iface.name();
     /// // Configure the device ‒ set IP address on it, bring it up.