package macaddr

  1. Overview
  2. Docs
package macaddr
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module MacaddrSource

A library for manipulation of MAC address representations.

v5.6.0 - homepage

Sourceexception Parse_error of string * string

Parse_error (err,packet) is raised when parsing of the MAC address syntax fails. err contains a human-readable error and packet is the original octet list that failed to parse.

Sourcetype t

Type of the hardware address (MAC) of an ethernet interface.

Functions converting MAC addresses to/from octets/string

Sourceval of_octets_exn : string -> t

of_octets_exn buf is the hardware address extracted from buf. Raises Parse_error if buf has not length 6.

Sourceval of_octets : string -> (t, [> `Msg of string ]) result

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

Sourceval of_string_exn : string -> t

of_string_exn mac_string is the human-readable hardware address represented by mac_string. Raises Parse_error if mac_string is not a valid representation of a MAC address.

Sourceval of_string : string -> (t, [> `Msg of string ]) result

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

Sourceval to_octets : t -> string

to_octets mac_addr is a string of size 6 encoding mac_addr as a sequence of bytes.

Sourceval to_string : ?sep:char -> t -> string

to_string ?(sep=':') mac_addr is the sep-separated string representation of mac_addr, i.e. xx:xx:xx:xx:xx:xx.

Sourceval pp : Format.formatter -> t -> unit

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

Sourceval broadcast : t

broadcast is ff:ff:ff:ff:ff:ff.

Sourceval make_local : (int -> int) -> t

make_local bytegen creates a unicast, locally administered MAC address given a function mapping octet offset to octet value.

Sourceval get_oui : t -> int

get_oui macaddr is the integer organization identifier for macaddr.

Sourceval is_local : t -> bool

is_local macaddr is the predicate on the locally administered bit of macaddr.

Sourceval is_unicast : t -> bool

is_unicast macaddr the is the predicate on the unicast bit of macaddr.

include Map.OrderedType with type t := t
Sourceval compare : t -> t -> int

A total ordering function over the keys. This is a two-argument function f such that f e1 e2 is zero if the keys e1 and e2 are equal, f e1 e2 is strictly negative if e1 is smaller than e2, and f e1 e2 is strictly positive if e1 is greater than e2. Example: a suitable ordering function is the generic structural comparison function Stdlib.compare.