package core_unix

  1. Overview
  2. Docs
package core_unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
type t = Core_unix__.Import.Unix.inet_addr
include Core.Bin_prot.Binable.S with type t := t
val bin_size_t : t Bin_prot__.Size.sizer
val bin_write_t : t Bin_prot__.Write.writer
val bin_read_t : t Bin_prot__.Read.reader
val __bin_read_t__ : (int -> t) Bin_prot__.Read.reader
val bin_shape_t : Bin_prot__.Shape.t
val bin_writer_t : t Bin_prot__.Type_class.writer
val bin_reader_t : t Bin_prot__.Type_class.reader
val bin_t : t Bin_prot__.Type_class.t
include Ppx_compare_lib.Comparable.S with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
val hash_fold_t : t Base__Ppx_hash_lib.hash_fold
val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value
val sexp_of_t : t -> Sexplib0.Sexp.t
val arg_type : t Core.Command.Arg_type.t
val t_of_sexp : Core.Sexp.t -> t

t_of_sexp is deprecated because it used to block to do a DNS lookup, and we don't want a sexp converter to do that. As we transition away, one can use Blocking_sexp, which has the old behavior.

  • deprecated [since 2015-10] Replace [t] by [Stable.V1.t] or by [Blocking_sexp.t]
module Blocking_sexp : sig ... end

Blocking_sexp performs DNS lookup to resolve hostnames to IP addresses.

include Core.Comparable.S with type t := t
include Base.Comparable.S with type t := t
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base__.Or_error.t
type comparator_witness
val comparator : (t, comparator_witness) Base__Comparator.comparator
val validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check
val validate_bound : min:t Core.Maybe_bound.t -> max:t Core.Maybe_bound.t -> t Validate.check
module Replace_polymorphic_compare : sig ... end
val of_string : string -> t

Conversion from the printable representation of an Internet address to its internal representation. The argument string consists of 4 numbers separated by periods (XXX.YYY.ZZZ.TTT) for IPv4 addresses, and up to 8 numbers separated by colons for IPv6 addresses. Raise Failure when given a string that does not match these formats.

val of_string_or_getbyname : string -> t

Call of_string and if that fails, use Host.getbyname.

val to_string : t -> string

Return the printable representation of the given Internet address. See of_string for a description of the printable representation.

val bind_any : t

A special address, for use only with bind, representing all the Internet addresses that the host machine possesses.

val bind_any_inet6 : t
val localhost : t

Special addresses representing the host machine.

127.0.0.1

val localhost_inet6 : t

(::1)

val inet4_addr_of_int32 : Core.Int32.t -> t

Some things (like the kernel) report addresses as hex or decimal strings. Provide conversion functions.

val inet4_addr_to_int32_exn : t -> Core.Int32.t

inet4_addr_to_int32_exn t = 0l when t = Inet_addr.of_string ("0.0.0.0"). An exception is raised if t is a not an IPv4 address.

val inet4_addr_of_int63 : Core.Int63.t -> t
val inet4_addr_to_int63_exn : t -> Core.Int63.t
module Stable : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct