package orsetto

  1. Overview
  2. Docs
A library of assorted structured data interchange languages

Install 

dune-project
 Dependency

bitbucket.org Edit opam file Versions (8)

Authors

  1. J
    james woodyatt <jhw@conjury.org>

Maintainers

  1. J
    james woodyatt <jhw@conjury.org>

Sources

r1.1.2.tar.gz
sha512=e260412b2dd0f98cfe3dc7ed5c31a694eb31c93cd207c51fa12675b790234ee0ad3bf07d9be17a4dc266fedfe55b14c967cad7bc0c9414063eef8afd59f3d0d1

doc/orsetto.cf/Cf_base64/Url/index.html

Module Cf_base64.Url

The "base64url" encoding. Pad characters are recommended (use ~np when including in a URL, because pads must be percent-encoded). Non-alphabet characters are forbidden.

val basis : Cf_radix_n.basis

The basis of the transform.

val decode_seq : ?n:int -> char Seq.t -> char Seq.t

Use decode_seq s to decode the digits in s according to the rules for the transform. Evaluating the result raises Error if an error in the encoding is encountered. Optionally use ~n to specify the required length of the decoded octets, raising Error if the end of s is not found immediately following the last digit in the encoding.

val decode_string : ?n:int -> string -> string option

Use decode_string s to decode the digits in s according to the rules for the transform. Returns None if an error is encountered. Optionally use ~n to specify the required length of the decoded octets.

val decode_slice : ?n:int -> string Cf_slice.t -> string option

Use decode_slice s to decode the digits in s according to the rules for the transform. Returns None if an error is encountered. Optionally use ~n to specify the required length of the decoded octets.

val encode_seq : ?brk:(int * string) -> ?np:unit -> char Seq.t -> char Seq.t

Use encode_seq s to encode the octets in s according to the rules for the transform. Use ~brk:(n, s) to insert s every n digits. Use ~np:() to disable output of pad characters. If pad characters are mandatory for the transform, then using ~np:() raises Invalid_argument.

val encode_string : ?brk:(int * string) -> ?np:unit -> string -> string

Use encode_string s to encode the octets in s according to the rules for the transform. Use ~brk:(bn, bs) to insert bs every bn digits. Use ~np:() to disable output of pad characters. If pad characters are mandatory for the transform, then using ~np:() raises Invalid_argument.

val encode_slice : ?brk:(int * string) -> ?np:unit -> string Cf_slice.t -> string

Use encode_slice s to encode the octets in s according to the rules for the transform. Use ~brk:(bn, bs) to insert bs every bn digits. Use ~np:() to disable output of pad characters. If pad characters are mandatory for the transform, then using ~np:() raises Invalid_argument.