network-internet-protocol 0.1.5

A domain model of internet protocol version 4 and version 6 host addresses, masks, network addresses and packets and associated types.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

// This file is part of dpdk. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/dpdk/master/COPYRIGHT. No part of dpdk, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2017 The developers of dpdk. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/dpdk/master/COPYRIGHT.


/// An internet protocol (IP) network address, either version 4 or version 6.
pub trait InternetProtocolNetworkAddress: Sized + Debug + Display + PartialOrd + Ord + PartialEq + Eq + Hash + Serialize + Clone
{
	/// Associated Internet Protocol (IP) host address, either version 4 or 6.
	type HostAddress: InternetProtocolHostAddress;
	
	/// Mask bits.
	type MaskBits: InternetProtocolMaskBits;
	
	/// Network information.
	#[inline(always)]
	fn network(&self) -> &Self::HostAddress;
	
	/// Number of mask bits, one based.
	///
	/// eg `/24` would be `24`.
	#[inline(always)]
	fn mask_bits(&self) -> Self::MaskBits;
	
	/// Number of mask bits, one based.
	///
	/// eg `/24` would be `24`.
	#[inline(always)]
	fn mask_bits_as_depth_u32(&self) -> u32
	{
		self.mask_bits_as_depth() as u32
	}
	
	/// Mask bits, one based.
	//	///
	//	/// eg `/24` would be `24`.
	#[inline(always)]
	fn mask_bits_as_depth(&self) -> u8
	{
		self.mask_bits().as_depth()
	}
	
	/// Does this network address contain the given `internet_protocol_host_address`?
	///
	/// In other words, is the given `internet_protocol_host_address` prefixed by this network address?
	#[inline(always)]
	fn contains(&self, internet_protocol_host_address: Self::HostAddress) -> bool;
	
	/// Creates new instance.
	#[inline(always)]
	fn new(network: Self::HostAddress, mask_bits: <<Self as InternetProtocolNetworkAddress>::HostAddress as InternetProtocolHostAddress>::MaskBits) -> Self;
}