Struct RoutesApi

pub struct RoutesApi<I: Ip, C>(/* private fields */);

The routes API for a specific IP version I.

Implementations

impl<I: Ip, C> RoutesApi<I, C>

pub fn new(ctx: C) -> Self

Creates a new API instance.

impl<I, C> RoutesApi<I, C>

where I: IpLayerIpExt + IpDeviceIpExt, C: ContextPair, C::CoreContext: RoutesApiCoreContext<I, C::BindingsContext>, C::BindingsContext: RoutesApiBindingsContext<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId: Ord,

pub fn new_table( &mut self, ) -> RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>

Allocates a new table in Core.

pub fn remove_table( &mut self, id: RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, ) -> RemoveResourceResultWithContext<(), C::BindingsContext>

Removes a table in Core.

Panics

Panics if id is the main table id.

pub fn main_table_id( &mut self, ) -> RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>

Gets the core ID of the main table.

pub fn collect_routes_into<X: From<Entry<I::Addr, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, T: Extend<X>>( &mut self, table_id: &RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, target: &mut T, )

Collects all the routes in the specified table into target.

pub fn collect_main_table_routes_into<X: From<Entry<I::Addr, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, T: Extend<X>>( &mut self, target: &mut T, )

Collects all the routes in the main table into target.

pub fn fold_routes<B, F>(&mut self, init: B, cb: F) -> B

where F: FnMut(B, &RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, &Entry<I::Addr, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>) -> B,

Like the Iterator fold accumulator.

Applies the given cb to each route across all routing tables.

pub fn resolve_route( &mut self, destination: Option<RoutableIpAddr<I::Addr>>, ) -> Result<ResolvedRoute<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, ResolveRouteError>

Resolve the route to a given destination.

Returns Some ResolvedRoute with details for reaching the destination, or None if the destination is unreachable.

pub fn select_device_for_gateway( &mut self, gateway: SpecifiedAddr<I::Addr>, ) -> Option<<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>

Selects the device to use for gateway routes when the device was unspecified by the client.

pub fn inspect<'a, N: Inspector + InspectorDeviceExt<<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>( &mut self, inspector: &mut N, )

Writes routing table information to the provided inspector.

pub fn set_routes( &mut self, table_id: &RoutingTableId<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, entries: Vec<EntryAndGeneration<I::Addr, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, )

Replaces the entire route table atomically.

pub fn set_rules( &mut self, rules: Vec<Rule<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, )

Replaces the entire rule table atomically.