ipaddr 3.1.0 · OCaml Package

A module for manipulating IPv6 network prefixes.

type addr = t

type t

Type of a internet protocol subnet

val mask : int -> addr

mask n is the pseudo-address of an n bit subnet mask.

val make : int -> addr -> t

make n addr is the n bit subnet prefix to which addr belongs.

val network_address : t -> addr -> addr

network_address prefix addr is the address with prefix prefix and suffix from addr. See <http://tools.ietf.org/html/rfc4291#section-2.3>.

val of_string_exn : string -> t

of_string_exn cidr is the subnet prefix represented by the CIDR string, cidr. Raises Parse_error if cidr is not a valid representation of a CIDR notation routing prefix.

val of_string : string -> (t, [> `Msg of string ]) Stdlib.result

Same as of_string_exn but returns a result type instead of raising an exception.

val of_string_raw : string -> int Stdlib.ref -> t

Same as of_string_exn but takes as an extra argument the offset into the string for reading.

val to_string : t -> string

to_string prefix is the CIDR notation string representation of prefix, i.e. XXX:XX:X::XXX/XX.

val pp : Stdlib.Format.formatter -> t -> unit

pp f prefix outputs a human-readable representation of prefix to the formatter f.

val of_address_string_exn : string -> t * addr

of_address_string_exn cidr_addr is the address and prefix represented by cidr_addr. Raises Parse_error if cidr_addr is not a valid representation of a CIDR-scoped address.

val of_address_string : string -> (t * addr, [> `Msg of string ]) Stdlib.result

Same as of_address_string_exn but returns an option type instead of raising an exception.

val to_address_string : t -> addr -> string

to_address_string prefix addr is the network address constructed from prefix and addr.

val to_buffer : Stdlib.Buffer.t -> t -> unit

to_buffer buf prefix writes the string representation of prefix to the buffer buf.

val to_address_buffer : Stdlib.Buffer.t -> t -> addr -> unit

to_address_buffer buf prefix addr writes string representation of the network address representing addr in prefix to the buffer buf.

val of_netmask : addr -> addr -> t

of_netmask netmask addr is the subnet prefix of addr with netmask netmask.

val mem : addr -> t -> bool

mem ip subnet checks whether ip is found within subnet.

val subset : subnet:t -> network:t -> bool

subset ~subnet ~network checks whether subnet is contained within network.

val of_addr : addr -> t

of_addr ip create a subnet composed of only one address, ip. It is the same as make 128 ip.

val global_unicast_001 : t

Global Unicast 001, 2000::/3.

val unique_local : t

The Unique Local Unicast (ULA), fc00::/7.

val link : t

Link-Local Unicast, fe80::/64.

val multicast : t

The multicast network, ff00::/8.

val ipv4_mapped : t

IPv4-mapped addresses, ::ffff:0:0/96.

val noneui64_interface : t

Global Unicast addresses that don't use Modified EUI64 interface identifiers, ::/3.

val solicited_node : t

Solicited-Node multicast addresses

val network : t -> addr

network subnet is the address for subnet.

val netmask : t -> addr

netmask subnet is the netmask for subnet.

val bits : t -> int

bits subnet is the bit size of the subnet prefix.

include Stdlib.Map.OrderedType with type t := t

val compare : t -> t -> int

package ipaddr