A | |
add [Data.Map] | |
add [Server.Data.Map] | |
any [Syntax] | |
any [Server.Syntax] | |
append [Jbuffer] | |
array [Syntax] | |
array [Server.Syntax] | |
B | |
boolean [Syntax] | |
boolean [Server.Syntax] | |
bprintf [Jbuffer] |
Prints into the buffer's formatter.
|
C | |
chapter [Doc] | |
chapter [Server.Doc] | |
clear [Data.Index] |
Clear index tables.
|
clear [Server.Data.Index] |
Clear index tables.
|
contents [Jbuffer] |
Flushes the buffer and returns its JSON enoding.
|
create [Jbuffer] |
Create a formatter with
~indent maximum indentation and
~margin right-margin.
|
D | |
default [Data.Record.S] | |
default [Server.Data.Record.S] | |
descr [Data.Info] | |
descr [Server.Data.Info] | |
dump [Doc] |
Dumps all published pages of documentations.
|
dump [Server.Doc] |
Dumps all published pages of documentations.
|
E | |
empty [Data.Map] | |
empty [Server.Data.Map] | |
exec [Main] | |
F | |
failure [Data] | |
failure [Server.Data] | |
failure_from_type_error [Data] | |
failure_from_type_error [Server.Data] | |
field [Data.Record] |
Adds a field to an opened record
|
field [Server.Data.Record] |
Adds a field to an opened record
|
fields [Syntax] |
Builds a table with fields column named with
~title
(shall be capitalized)
|
fields [Server.Syntax] |
Builds a table with fields column named with
~title
(shall be capitalized)
|
find [Main] | |
find [Data.Map] | |
find [Data.Index] | |
find [Server.Data.Map] | |
find [Server.Data.Index] | |
flush [Jbuffer] | |
format [Jbuffer] |
All-in-one formatter.
|
formatter [Jbuffer] |
The underlying formatter of a buffer.
|
fprintf [Jbuffer] |
Prints back a JSON encoding onto the provided formatter.
|
G | |
get [Data.Index] | |
get [Data.Record.S] | |
get [Server.Data.Index] | |
get [Server.Data.Record.S] | |
get_function_name [Parameter_sig.String] |
returns the given argument only if it is a valid function name
(see
Parameter_customize.get_c_ified_functions for more information),
and abort otherwise.
|
get_plain_string [Parameter_sig.String] |
always return the argument, even if the argument is not a function name.
|
get_possible_values [Parameter_sig.String] |
What are the acceptable values for this parameter.
|
get_range [Parameter_sig.Int] |
What is the possible range of values for this parameter.
|
H | |
has [Data.Record.S] | |
has [Server.Data.Record.S] | |
href [Doc] | |
href [Server.Doc] | |
I | |
id [Data.IdentifiedType] | |
id [Server.Data.IdentifiedType] | |
ident [Syntax] | |
ident [Server.Syntax] | |
incr [Parameter_sig.Int] |
Increment the integer.
|
int [Syntax] | |
int [Server.Syntax] | |
K | |
kill [Main] |
Kills the currently running request.
|
N | |
name [Data.Info] | |
name [Server.Data.Info] | |
number [Syntax] | |
number [Server.Syntax] | |
O | |
of_json [Request.Input] | |
of_json [Data.S] | |
of_json [Server.Request.Input] | |
of_json [Server.Data.S] | |
off [Parameter_sig.Bool] |
Set the boolean to
false .
|
on [Main] |
Register a callback to listen for server activity.
|
on [Parameter_sig.Bool] |
Set the boolean to
true .
|
option [Data.Record] |
Adds a optional field to an opened record
|
option [Syntax] | |
option [Server.Data.Record] |
Adds a optional field to an opened record
|
option [Server.Syntax] | |
P | |
page [Data.Info] | |
page [Doc] |
Obtain the given page in the server documentation.
|
page [Server.Data.Info] | |
page [Server.Doc] |
Obtain the given page in the server documentation.
|
param [Request] |
Named input parameter.
|
param [Server.Request] |
Named input parameter.
|
param_opt [Request] |
Named optional input parameter.
|
param_opt [Server.Request] |
Named optional input parameter.
|
path [Doc] | |
path [Server.Doc] | |
pop_tag [Jbuffer] | |
pp_kind [Main] | |
pretty [Data] | |
pretty [Server.Data] | |
publish [Data.Record] |
Publish and close an opened record
|
publish [Syntax] |
The provided synopsis must be very short, to fit in one line.
|
publish [Doc] |
Adds a section in the corresponding page.
|
publish [Server.Data.Record] |
Publish and close an opened record
|
publish [Server.Syntax] |
The provided synopsis must be very short, to fit in one line.
|
publish [Server.Doc] |
Adds a section in the corresponding page.
|
push_tag [Jbuffer] | |
R | |
record [Syntax] | |
record [Server.Syntax] | |
register [Request] |
Register a simple request of type
(a -> b) .
|
register [Main] | |
register [Server.Request] |
Register a simple request of type
(a -> b) .
|
register_sig [Request] |
Register the request JSON processing function.
|
register_sig [Server.Request] |
Register the request JSON processing function.
|
result [Request] |
Named output parameter.
|
result [Server.Request] |
Named output parameter.
|
result_opt [Request] |
Named optional output parameter.
|
result_opt [Server.Request] |
Named optional output parameter.
|
run [Main] |
Run a server with the provided low-level network primitives to
actually exchange data.
|
S | |
set [Data.Record.S] | |
set [Server.Data.Record.S] | |
set_possible_values [Parameter_sig.String] |
Set what are the acceptable values for this parameter.
|
set_range [Parameter_sig.Int] |
Set what is the possible range of values for this parameter.
|
signature [Request] |
Create an opened request signature.
|
signature [Data.Record] |
Create a new, opened record type
|
signature [Server.Request] |
Create an opened request signature.
|
signature [Server.Data.Record] |
Create a new, opened record type
|
string [Syntax] | |
string [Server.Syntax] | |
string_of_kind [Main] | |
syntax [Request.Output] | |
syntax [Request.Input] | |
syntax [Data.S] | |
syntax [Server.Request.Output] | |
syntax [Server.Request.Input] | |
syntax [Server.Data.S] | |
T | |
tag [Syntax] | |
tag [Server.Syntax] | |
text [Syntax] | |
text [Server.Syntax] | |
to_json [Request.Output] | |
to_json [Data.S] | |
to_json [Jbuffer] |
All-in-one formatter.
|
to_json [Server.Request.Output] | |
to_json [Server.Data.S] | |
tuple [Syntax] | |
tuple [Server.Syntax] | |
U | |
union [Syntax] | |
union [Server.Syntax] | |
unit [Syntax] | |
unit [Server.Syntax] | |
V | |
values [Data.Enum] | |
values [Server.Data.Enum] | |
W | |
with_unfold_precond [Printer_tag.S_pp] | |
wkind [Server_parameters] |
Inconsistent category warning
|
wname [Server_parameters] |
Invalid name warning
|
wpage [Server_parameters] |
Inconsistent page warning
|
Y | |
yield [Main] |
Yield the server during the currently running request.
|