Struct igd::tokio::Gateway

source · [−]

pub struct Gateway { /* private fields */ }

Expand description

This structure represents a gateway found by the search functions.

Implementations

source

impl Gateway

source

pub fn new(addr: SocketAddrV4, control_url: String, handle: Handle) -> Gateway

Create a new Gateway for a given Handle to a control loop

source

pub fn get_external_ip(
&self
) -> Box<dyn Future<Item = Ipv4Addr, Error = GetExternalIpError>>

Get the external IP address of the gateway in a tokio compatible way

source

pub fn get_any_address(
 &self,
 protocol: PortMappingProtocol,
 local_addr: SocketAddrV4,
 lease_duration: u32,
 description: &str
) -> Box<dyn Future<Item = SocketAddrV4, Error = AddAnyPortError>>

Get an external socket address with our external ip and any port. This is a convenience function that calls get_external_ip followed by add_any_port

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

Returns

The external address that was mapped on success. Otherwise an error.

source

pub fn add_any_port(
 &self,
 protocol: PortMappingProtocol,
 local_addr: SocketAddrV4,
 lease_duration: u32,
 description: &str
) -> Box<dyn Future<Item = u16, Error = AddAnyPortError>>

Add a port mapping.with any external port.

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

Returns

The external port that was mapped on success. Otherwise an error.

source

pub fn add_port(
 &self,
 protocol: PortMappingProtocol,
 external_port: u16,
 local_addr: SocketAddrV4,
 lease_duration: u32,
 description: &str
) -> Box<dyn Future<Item = (), Error = AddPortError>>

Add a port mapping.

The local_addr is the address where the traffic is sent to. The lease_duration parameter is in seconds. A value of 0 is infinite.

source

pub fn remove_port(
 &self,
 protocol: PortMappingProtocol,
 external_port: u16
) -> Box<dyn Future<Item = (), Error = RemovePortError>>

Remove a port mapping.

Trait Implementations

source

impl Clone for Gateway

source

fn clone(&self) -> Gateway

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

impl Debug for Gateway

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Display for Gateway

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

source

impl Hash for Gateway

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<Gateway> for Gateway

source

fn eq(&self, other: &Gateway) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

source

impl Eq for Gateway

Auto Trait Implementations

impl !RefUnwindSafe for Gateway

impl !Send for Gateway

impl !Sync for Gateway

impl Unpin for Gateway

impl !UnwindSafe for Gateway

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct igd::tokio::Gateway

Implementations

impl Gateway

pub fn new(addr: SocketAddrV4, control_url: String, handle: Handle) -> Gateway

pub fn get_external_ip( &self) -> Box<dyn Future<Item = Ipv4Addr, Error = GetExternalIpError>>

pub fn get_any_address( &self, protocol: PortMappingProtocol, local_addr: SocketAddrV4, lease_duration: u32, description: &str) -> Box<dyn Future<Item = SocketAddrV4, Error = AddAnyPortError>>

pub fn add_any_port( &self, protocol: PortMappingProtocol, local_addr: SocketAddrV4, lease_duration: u32, description: &str) -> Box<dyn Future<Item = u16, Error = AddAnyPortError>>

pub fn add_port( &self, protocol: PortMappingProtocol, external_port: u16, local_addr: SocketAddrV4, lease_duration: u32, description: &str) -> Box<dyn Future<Item = (), Error = AddPortError>>

pub fn remove_port( &self, protocol: PortMappingProtocol, external_port: u16) -> Box<dyn Future<Item = (), Error = RemovePortError>>

Trait Implementations

impl Clone for Gateway

fn clone(&self) -> Gateway

fn clone_from(&mut self, source: &Self)

impl Debug for Gateway

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Display for Gateway

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Hash for Gateway

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<Gateway> for Gateway

fn eq(&self, other: &Gateway) -> bool

fn ne(&self, other: &Rhs) -> bool

impl Eq for Gateway

Auto Trait Implementations

impl !RefUnwindSafe for Gateway

impl !Send for Gateway

impl !Sync for Gateway

impl Unpin for Gateway

impl !UnwindSafe for Gateway

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn get_external_ip(
&self
) -> Box<dyn Future<Item = Ipv4Addr, Error = GetExternalIpError>>

pub fn get_any_address(
&self,
protocol: PortMappingProtocol,
local_addr: SocketAddrV4,
lease_duration: u32,
description: &str
) -> Box<dyn Future<Item = SocketAddrV4, Error = AddAnyPortError>>

pub fn add_any_port(
&self,
protocol: PortMappingProtocol,
local_addr: SocketAddrV4,
lease_duration: u32,
description: &str
) -> Box<dyn Future<Item = u16, Error = AddAnyPortError>>

pub fn add_port(
&self,
protocol: PortMappingProtocol,
external_port: u16,
local_addr: SocketAddrV4,
lease_duration: u32,
description: &str
) -> Box<dyn Future<Item = (), Error = AddPortError>>

pub fn remove_port(
&self,
protocol: PortMappingProtocol,
external_port: u16
) -> Box<dyn Future<Item = (), Error = RemovePortError>>

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,