package bookaml

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Exceptions
Type definitions
Public functions and values
1. Conversion to/from strings
2. Validity checks

bookaml
- Bookaml_amazon
  - ENGINE
  - HTTPGETTER
    
    Monad
  - Locale
  - Make
    
    Httpgetter
    
    Monad
    
    Xmlhandler
  - XMLHANDLER
- Bookaml_book
- Bookaml_isbn
bookaml.ocamlnet
- Bookaml_amazon_ocamlnet

Legend:
Library
Module
Module type
Parameter
Class
Class type

Module encapsulating ISBNs. It takes advantage of the check digit to make sure that any given ISBN is correct. It supports both 10 and 13-digit ISBNs.

Exceptions

exception Bad_isbn_length of string

exception Bad_isbn_checksum of string

exception Bad_isbn_character of char

Type definitions

type t

The type of valid ISBN numbers.

include Sexplib0.Sexpable.S with type t := t

val t_of_sexp : Sexplib0__.Sexp.t -> t

val sexp_of_t : t -> Sexplib0__.Sexp.t

Public functions and values

Conversion to/from strings

val of_string : string -> t

Converts a string into an ISBN, represented by type t. Raises an exception if the string cannot be converted into a valid ISBN. Both 10 and 13-digit ISBNs are accepted. Moreover, the string may contain dashes, which are automatically removed if present.

val to_string : t -> string

Returns a string representation of the ISBN. The same type of ISBN (10 or 13-digit) originally used to construct the value is returned, but without any dashes.

val to_string10 : t -> string option

Returns a string with the 10-digit ISBN representation of t. Since it is not always possible to construct a 10-digit ISBN from a 13-digit one, the function may return None.

val to_string13 : t -> string

Returns a string with the 13-digit ISBN representation of t. Note that it is always possible to build a 13-digit ISBN.

Validity checks

val is_valid : string -> bool

Does the given string represent a valid ISBN number? Both 10 and 13-digit ISBNs are accepted. Moreover, the string may contain dashes, which are automatically removed if present.

val is_valid10 : string -> bool

Does the given string represent a valid 10-digit ISBN number? The string may contain dashes, which are automatically removed if present.

val is_valid13 : string -> bool

Does the given string represent a valid 13-digit ISBN number? The string may contain dashes, which are automatically removed if present.