package ocsigenserver

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

Module Ocsigen_lib.UrlSource

include module type of Url_base with type t = Url_base.t
type t = Url_base.t
type uri = string
val make_absolute_url : https:bool -> host:string -> port:int -> uri -> t

make_absolute_url https host port path generates a new absolute url

type path = string list
val remove_dotdot : path -> path

remove_dotdot path cleans the path of ..

val remove_end_slash : string -> string

remove_end_slash str removes last /

val remove_internal_slash : path -> path

remove_internal_slash path cleans the path of empty string

val change_empty_list : path -> path
val add_end_slash_if_missing : path -> path
val remove_slash_at_end : path -> path
val remove_slash_at_beginning : path -> path
val is_prefix_skip_end_slash : string list -> string list -> bool

is_prefix_skip_end_slash path1 path2 returns true if path1 is the same as path2 before a first slash

val split_fragment : string -> string * string option

split_fragment str splits str at first '#'

val join_path : path -> string
Sourceval fixup_url_string : t -> t
Sourceval encode : ?plus:bool -> string -> string
Sourceval decode : ?plus:bool -> string -> string
Sourceval make_encoded_parameters : (string * string) list -> string
Sourceval string_of_url_path : encode:bool -> path -> uri
Sourceval parse : t -> bool option * string option * int option * string * string list * string option * (string * string) list Lazy.t

parse url returns a tuple containing information about url

  • If url contains scheme 'https'
  • host of url (ex: http://www.ocsigen.org/ -> www.ocsigen.org)
  • port of url
  • path as string without first '/'
  • path as string list
  • GET query of url
  • lazy value to decode GET query
Sourceval prefix_and_path_of_t : string -> string * string list

prefix_and_path_of_t url splits url in a couple (prefix, path) where prefix is "http(s)://host:port" and path is the path as string list

Example: prefix_and_path_of_t "http://ocsigen.org:80/tuto/manual" returns ("http://ocsigen.org:80", ["tuto", "manual"]).

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