1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! This library allows you to communicate with an IGD enabled device.
//! Use one of the `search_gateway` functions to obtain a `Gateway` object.
//! You can then communicate with the device via this object.

#![deny(missing_docs)]

extern crate hyper;
extern crate regex;
extern crate xml;
extern crate xmltree;
extern crate rand;
extern crate futures;
extern crate tokio_core;
extern crate tokio_timer;
extern crate tokio_retry;

// data structures
pub use self::gateway::Gateway;
pub use self::errors::{SearchError, RequestError, GetExternalIpError, AddPortError,
                       AddAnyPortError, RemovePortError};

// search of gateway
pub use self::search::search_gateway;
pub use self::search::search_gateway_timeout;
pub use self::search::search_gateway_from;
pub use self::search::search_gateway_from_timeout;

/// Contains Tokio compatible implementations for finding a gateway and configuring port mappings
pub mod tokio {
    pub use async::{Gateway, search_gateway_from_timeout, search_gateway_from,
                    search_gateway_timeout, search_gateway};
}

// re-export error types
pub use hyper::Error as HttpError;
pub use xml::reader::Error as XmlError;

mod gateway;
mod search;
mod soap;
mod async;
mod errors;

use std::fmt;

/// Represents the protocols available for port mapping.
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum PortMappingProtocol {
    /// TCP protocol
    TCP,
    /// UDP protocol
    UDP,
}

impl fmt::Display for PortMappingProtocol {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "{}",
            match *self {
                PortMappingProtocol::TCP => "TCP",
                PortMappingProtocol::UDP => "UDP",
            }
        )
    }
}