package ipaddr-cstruct

  1. Overview
  2. Docs
package ipaddr-cstruct
Legend:
Library
Module
Module type
Parameter
Class
Class type

Ipv6 address conversions

val of_cstruct : Cstruct.t -> (Ipaddr.V6.t, [> `Msg of string ]) Stdlib.result

of_cstruct c parses the first 16 octets of c into an IPv6 address.

val of_cstruct_exn : Cstruct.t -> Ipaddr.V6.t

of_cstruct_exn parses the first 16 octets of c into an IPv6 address. Raises Ipaddr.Parse_failure on error.

val to_cstruct : ?allocator:(int -> Cstruct.t) -> Ipaddr.V6.t -> Cstruct.t

to_cstruct ipv6 is a cstruct of length 16 encoding ipv6. The cstruct is allocated using allocator. If allocator is not provided, Cstruct.create is used.

val write_cstruct_exn : Ipaddr.V6.t -> Cstruct.t -> unit

write_cstruct_exn ipv6 cs writes 16 bytes into cs representing the ipv6 address octets. Raises Ipaddr.Parse_error if cs is not at least 16 bytes long.