package posix-errno

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Errno Type
Errno Conversion
Errno Access
Error Raising
Specialized Error Checkers
Unix Error Conversion
Error String Functions
Native Definition Detection

package posix-errno

posix-errno
- CHANGES
- README
- Library posix-errno
  - Posix_errno
- Library posix-errno.constants
  - Posix_errno_constants
    
    Def
- Library posix-errno.stubs
  - Posix_errno_stubs
    
    Def
- Sources
  - posix-errno
    
    posix_errno.ml
    
    posix_errno__.ml
    
    posix_errno_conversions.ml
    
    posix_errno_generated_constants.ml
    
    posix_errno_generated_stubs.ml
    
    posix_errno_is_native_impl.ml
    
    posix_errno_type.ml
  - posix-errno.constants
    
    posix_errno_constants.ml
  - posix-errno.stubs
    
    posix_errno_stubs.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Posix_errno`Source

POSIX errno handling

Errno Type

Sourcetype t = [

| `E2BIG
| `EACCES
| `EADDRINUSE
| `EADDRNOTAVAIL
| `EAFNOSUPPORT
| `EAGAIN
| `EALREADY
| `EBADF
| `EBADMSG
| `EBUSY
| `ECANCELED
| `ECHILD
| `ECONNABORTED
| `ECONNREFUSED
| `ECONNRESET
| `EDEADLK
| `EDESTADDRREQ
| `EDOM
| `EDQUOT
| `EEXIST
| `EFAULT
| `EFBIG
| `EHOSTDOWN
| `EHOSTUNREACH
| `EIDRM
| `EILSEQ
| `EINPROGRESS
| `EINTR
| `EINVAL
| `EIO
| `EISCONN
| `EISDIR
| `ELOOP
| `EMFILE
| `EMLINK
| `EMSGSIZE
| `EMULTIHOP
| `ENAMETOOLONG
| `ENETDOWN
| `ENETRESET
| `ENETUNREACH
| `ENFILE
| `ENOBUFS
| `ENODATA
| `ENODEV
| `ENOENT
| `ENOEXEC
| `ENOLCK
| `ENOLINK
| `ENOMEM
| `ENOMSG
| `ENOPROTOOPT
| `ENOSPC
| `ENOSR
| `ENOSTR
| `ENOSYS
| `ENOTCONN
| `ENOTDIR
| `ENOTEMPTY
| `ENOTRECOVERABLE
| `ENOTSOCK
| `ENOTSUP
| `ENOTTY
| `ENXIO
| `EOPNOTSUPP
| `EOVERFLOW
| `EOWNERDEAD
| `EPERM
| `EPFNOSUPPORT
| `EPIPE
| `EPROTO
| `EPROTONOSUPPORT
| `EPROTOTYPE
| `ERANGE
| `EREMOTE
| `EROFS
| `ESHUTDOWN
| `ESOCKTNOSUPPORT
| `ESPIPE
| `ESRCH
| `ESTALE
| `ETIME
| `ETIMEDOUT
| `ETOOMANYREFS
| `ETXTBSY
| `EUSERS
| `EWOULDBLOCK
| `EXDEV
| `EBADE
| `EBADFD
| `EBADR
| `EBADRQC
| `EBADSLT
| `ECHRNG
| `ECOMM
| `EDEADLOCK
| `EHWPOISON
| `EISNAM
| `EKEYEXPIRED
| `EKEYREJECTED
| `EKEYREVOKED
| `EL2HLT
| `EL2NSYNC
| `EL3HLT
| `EL3RST
| `ELIBACC
| `ELIBBAD
| `ELIBEXEC
| `ELIBMAX
| `ELIBSCN
| `ELNRNG
| `EMEDIUMTYPE
| `ENOANO
| `ENOKEY
| `ENOMEDIUM
| `ENONET
| `ENOPKG
| `ENOTBLK
| `ENOTUNIQ
| `EREMCHG
| `EREMOTEIO
| `ERESTART
| `ERFKILL
| `ESTRPIPE
| `ETOOBIG
| `EUCLEAN
| `EUNATCH
| `EXFULL
| `EAUTH
| `EBADRPC
| `EFTYPE
| `ENEEDAUTH
| `ENOCSI
| `EPROCLIM
| `EPROCUNAVAIL
| `EPROGMISMATCH
| `EPROGUNAVAIL
| `ERPCMISMATCH
| `EATTR
| `EBADARCH
| `EBADEXEC
| `EBADMACHO
| `EDEVERR
| `ENOATTR
| `ENOPOLICY
| `EPWROFF
| `ESHLIBVERS
| `EOTHER
| `EUNKNOWN of int

]

Comprehensive errno type covering Linux, BSD, macOS, and Windows values

Errno Conversion

Sourceval of_int : int -> t

Convert errno code to variant

Sourceval to_int : t -> int

Convert variant to errno code

Errno Access

Sourceval get_errno : unit -> t

Get current errno value

Sourceval get_errno_int : unit -> int

Get current errno as int

Sourceval reset_errno : unit -> unit

Reset errno to 0

Error Raising

Sourceval raise_on_error : ?call:string -> (unit -> 'a) -> ('a -> bool) -> 'a

Generic error-raising function.

raise_on_error ?call f check calls f() and checks the result with check. If check returns true, raises a Unix_error based on the current errno.

parameter call
Optional name of the calling function (for error messages)

parameter f
Function to execute

parameter check
Function to check if result indicates an error

returns
The result of f() if no error occurred

raises Unix_error
if check returns true

Specialized Error Checkers

Sourceval raise_on_neg : ?call:string -> (unit -> int) -> int

Check for negative integer return (common for syscalls). Raises Unix_error if result < 0.

Sourceval raise_on_null : ?call:string -> (unit -> 'a Ctypes.ptr) -> 'a Ctypes.ptr

Check for null pointer return (for C functions). Raises Unix_error if result is null.

Sourceval raise_on_zero : ?call:string -> (unit -> int) -> int

Check for zero return value (some functions return 0 on error). Raises Unix_error if result = 0.

Sourceval raise_on_none : ?call:string -> (unit -> 'a option) -> 'a

Check for None return value. Raise Unix_error if result = None.

Unix Error Conversion

Sourceval to_unix_error : t -> Unix.error

Convert errno variant to Unix.error

Sourceval int_to_unix_error : int -> Unix.error

Convert errno int to Unix.error

Error String Functions

Sourceval strerror : t -> string

Get error message string for an errno value using strerror. This function is cross-platform (works on both POSIX and Windows) but not thread-safe.

parameter errnum
The errno value to get the message for

returns
Error message string

Sourceval strerror_r : ?buflen:int -> t -> string

Get error message string for an errno value using strerror_r. This function is thread-safe but only available on POSIX systems.

parameter buflen
Optional buffer length for error message (default: 1024)

parameter errn
The errno value to get the message for

returns
Error message string

raises Invalid_argument
on Windows where strerror_r is not available

raises Unix_error
if strerror_r fails

Native Definition Detection

Sourceval is_native : t -> bool

Check if an errno value is natively defined on this platform. Returns true if the errno is natively defined by the system, false if it's using a placeholder fallback value.

This is useful to determine if an errno constant represents a real system error on the current platform, or if it's just a placeholder value (typically in the 10000+ range) that was assigned because the error doesn't exist on this system.

parameter errnum
The errno value to check

returns
true if natively defined, false if using placeholder

package posix-errno

Module Posix_errnoSource

Errno Type

Errno Conversion

Errno Access

Error Raising

Specialized Error Checkers

Unix Error Conversion

Error String Functions

Native Definition Detection

Module `Posix_errno`Source