Trait iptrie::IpPrefix

pub trait IpPrefix: Debug + Clone + Copy {
    type Slot: BitSlot;
    type Addr: Display + Clone + Copy + Eq + Hash;

    const MAX_LEN: u8;

    // Required methods
    fn root() -> Self;
    fn bitslot(&self) -> Self::Slot;
    fn bitslot_trunc(&self) -> Self::Slot;
    fn len(&self) -> u8;
    fn network(&self) -> Self::Addr;

    // Provided method
    fn bitmask(&self) -> Self::Slot { ... }
}

Ip prefix (as bit prefix)

Required Associated Types

type Slot: BitSlot

The slot manipulated inside this prefix

type Addr: Display + Clone + Copy + Eq + Hash

The underlying ip address (usually Ipv4Addr or Ipv6Addr)

Required Associated Constants

const MAX_LEN: u8

The maximum allowed length for this prefix

Required Methods

fn root() -> Self

Root prefix has a length of 0

fn bitslot(&self) -> Self::Slot

The inner slot as is

Depending of the implementation, there is no warranty that the masked bits (i.e. with position greater than the length) are set to 0.

For a version of a slot with masked bits set to 0, see Self::bitslot_trunc.

fn bitslot_trunc(&self) -> Self::Slot

The inner slot with all the masked bits set to 0.

The result always equals self.bitslot() & self.bitmask() but it is usually faster to compute (depending on the prefix structure)

fn len(&self) -> u8

Length of the prefix.

This is the number of significant first bits. Others should be considered as 0 (event if not)

fn network(&self) -> Self::Addr

The address of the network defined by the prefixv

All the bits greater than the prefix length are set to 0

Provided Methods

fn bitmask(&self) -> Self::Slot

Mask of the prefix.

The n (prefix length) first bits are set to 1 and the last ones are set to 0.

Implementations on Foreign Types

impl IpPrefix for Ipv6Addr

type Slot = u128

fn root() -> Self

fn bitslot(&self) -> Self::Slot

fn bitslot_trunc(&self) -> Self::Slot

fn len(&self) -> u8

const MAX_LEN: u8 = 128u8

type Addr = Ipv6Addr

fn network(&self) -> Self::Addr

impl IpPrefix for Ipv6Net

type Slot = u128

fn root() -> Self

fn bitslot(&self) -> Self::Slot

fn bitslot_trunc(&self) -> Self::Slot

fn len(&self) -> u8

const MAX_LEN: u8 = 128u8

type Addr = Ipv6Addr

fn network(&self) -> Self::Addr

impl IpPrefix for Ipv4Net

type Slot = u32

fn root() -> Self

fn bitslot(&self) -> Self::Slot

fn bitslot_trunc(&self) -> Self::Slot

fn len(&self) -> u8

const MAX_LEN: u8 = 32u8

type Addr = Ipv4Addr

fn network(&self) -> Self::Addr

impl IpPrefix for Ipv4Addr

type Slot = u32

fn root() -> Self

fn bitslot(&self) -> Self::Slot

fn bitslot_trunc(&self) -> Self::Slot

fn len(&self) -> u8

const MAX_LEN: u8 = 32u8

type Addr = Ipv4Addr

fn network(&self) -> Self::Addr

Implementors

impl IpPrefix for Ipv4Prefix

type Slot = u32

const MAX_LEN: u8 = 32u8

type Addr = Ipv4Addr

impl IpPrefix for Ipv6Prefix56

type Slot = u64

const MAX_LEN: u8 = 56u8

type Addr = Ipv6Addr

impl IpPrefix for Ipv6Prefix120

type Slot = u128

const MAX_LEN: u8 = 120u8

type Addr = Ipv6Addr

impl IpPrefix for Ipv6Prefix

type Slot = u128

const MAX_LEN: u8 = 128u8

type Addr = Ipv6Addr