Struct smoltcp::iface::Routes

pub struct Routes<'a> { /* fields omitted */ }

A routing table.

Examples

On systems with heap, this table can be created with:

use std::collections::BTreeMap;
use smoltcp::iface::Routes;
let mut routes = Routes::new(BTreeMap::new());

On systems without heap, use:

use smoltcp::iface::Routes;
let mut routes_storage = [];
let mut routes = Routes::new(&mut routes_storage[..]);

Implementations

impl<'a> Routes<'a>

pub fn new<T>(storage: T) -> Routes<'a> where
    T: Into<ManagedMap<'a, IpCidr, Route>>, 

Creates a routing tables. The backing storage is not cleared upon creation.

pub fn update<F: FnOnce(&mut ManagedMap<'a, IpCidr, Route>)>(&mut self, f: F)

Update the routes of this node.

pub fn add_default_ipv4_route(
    &mut self,
    gateway: Ipv4Address
) -> Result<Option<Route>>

Add a default ipv4 gateway (ie. “ip route add 0.0.0.0/0 via gateway”).

On success, returns the previous default route, if any.

pub fn add_default_ipv6_route(
    &mut self,
    gateway: Ipv6Address
) -> Result<Option<Route>>

Add a default ipv6 gateway (ie. “ip -6 route add ::/0 via gateway”).

On success, returns the previous default route, if any.

pub fn remove_default_ipv4_route(&mut self) -> Option<Route>

Remove the default ipv4 gateway

On success, returns the previous default route, if any.

pub fn remove_default_ipv6_route(&mut self) -> Option<Route>

Remove the default ipv6 gateway

On success, returns the previous default route, if any.

Trait Implementations

impl<'a> Debug for Routes<'a>

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

Formats the value using the given formatter.