package js_of_ocaml

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

Module Js_of_ocaml.UrlSource

This module provides functions for tampering with Url. It's main goal is to allow one to stay in the Ocaml realm without wandering into the Dom_html.window##.location object.

The first functions are mainly from and to string conversion functions for the different parts of a url.

Sourceval urldecode : string -> string

urldecode s swaps percent encoding characters for their usual representation.

Sourceval urlencode : ?with_plus:bool -> string -> string

urlencode ?with_plus s replace characters for their percent encoding representation. Note that the '/' (slash) character is escaped as well. If with_plus is true (default) then '+''s are escaped as "%2B". If not, '+''s are left as is.

Sourcetype http_url = {
  1. hu_host : string;
    (*

    The host part of the url.

    *)
  2. hu_port : int;
    (*

    The port for the connection if any.

    *)
  3. hu_path : string list;
    (*

    The path split on '/' characters.

    *)
  4. hu_path_string : string;
    (*

    The original entire path.

    *)
  5. hu_arguments : (string * string) list;
    (*

    Arguments as a field-value association list.

    *)
  6. hu_fragment : string;
    (*

    The fragment part (after the '#' character).

    *)
}

The type for HTTP(s) url.

Sourcetype file_url = {
  1. fu_path : string list;
  2. fu_path_string : string;
  3. fu_arguments : (string * string) list;
  4. fu_fragment : string;
}

The type for local file urls.

Sourcetype url =
  1. | Http of http_url
    (*

    Non secure HTTP urls

    *)
  2. | Https of http_url
    (*

    Secure HTTPS urls

    *)
  3. | File of file_url
    (*

    Local files

    *)

The type for urls.

Sourceval default_http_port : int

The default port for Http communications (80).

Sourceval default_https_port : int

The default port for Https communications (443).

Sourceval path_of_path_string : string -> string list

path_of_path_string s splits s on each "/" character.

Sourceval encode_arguments : (string * string) list -> string

encode_arguments a expects a list of pair of values of the form (name,value) were name is the name of an argument and value it's associated value.

Sourceval decode_arguments : string -> (string * string) list

decode_arguments s parses s returning the sliced-diced association list. s should be only the arguments part (after the '?') not the whole url.

The following part allow one to handle Url object in a much higher level than what a string provides.

Sourceval url_of_string : string -> url option

url_of_string s parses s and builds a value of type url if s is not a valid url string, it returns None.

Sourceval string_of_url : url -> string

string_of_url u returns a valid string representation of u. Note that * string_of_url ((fun Some u -> u) (url_of_string s)) is NOT necessarily * equal to s. However url_of_string (string_of_url u) = u.

Sourcemodule Current : sig ... end

This module can be used to handle the Url associated to the current document.