Skip to main content

Aggregator

Struct Aggregator 

Source
pub struct Aggregator { /* private fields */ }
Expand description

Collects ranges and produces the minimal covering prefix list.

Exclusions are subtracted address by address: the summary covers exactly the added addresses minus the excluded ones, whatever the order of calls and however the inputs overlap. A prefix that partly overlaps an exclusion is split around it.

use route_summarization::Aggregator;

let mut agg = Aggregator::new();
agg.add_str("192.0.2.0/24", false).unwrap();
agg.exclude_str("192.0.2.0/25", false).unwrap();
agg.exclude_str("192.0.2.255", false).unwrap();
let out: Vec<String> = agg.summarize().iter().map(|p| p.to_string()).collect();
assert_eq!(out, ["192.0.2.128/26", "192.0.2.192/27", "192.0.2.224/28",
                 "192.0.2.240/29", "192.0.2.248/30", "192.0.2.252/31", "192.0.2.254"]);

Implementations§

Source§

impl Aggregator

Source

pub fn new() -> Self

Source

pub fn add(&mut self, r: Range)

Source

pub fn add_str(&mut self, input: &str, spf: bool) -> Result<(), ParseError>

Parse and add one entry; see parse_entry.

Source

pub fn exclude(&mut self, r: Range)

Remove these addresses from the summary, wherever they appear.

Source

pub fn exclude_str(&mut self, input: &str, spf: bool) -> Result<(), ParseError>

Parse and exclude one entry; see parse_entry.

Source

pub fn is_empty(&self) -> bool

True when nothing has been added (exclusions alone don’t count).

Source

pub fn summarize(&self) -> Vec<Prefix>

Minimal CIDR list: all IPv4 first, then IPv6, each in address order.

Trait Implementations§

Source§

impl Clone for Aggregator

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Aggregator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Aggregator

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

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,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.