Library reference

Find a shared function, pipeline stage, operator or special form here. The entries describe Zirql 0.3.0. Hosts may pin earlier Zirql versions or expose a smaller frontend; check their own guides before using a form in a consumer.

A shared operation can support ordinary values, native inputs, or both. Each entry describes its supported forms and host requirements. Native inputs need host adapters and retain their objects and source context. Domain-specific names belong to the Zirium and Zincite references. Proposed language/CP forms are outside this library reference.

Each shared operation has one entry covering its constructed and native forms, including the native projections and result shapes that differ. Each entry gives its inputs, result, example and relevant empty/error/order rules. All operations spend the active finite request budget. Preflight scope, known-type and purity checks apply even to empty input and unselected branches; runtime errors in skipped branches remain unexecuted. See diagnostics and limits.

Browse by purpose

• Scalars and strings
• Presence and lookup
• Operators and access
• Collections and reductions
• Ordering and extrema
• Grouping and neighbourhoods
• Collection pipeline stages
• Functions and control flow
• Queues and native identity sets
• Shared native forms
• JSON and Markdown rendering (Rust API)

Rust adapters can build direct native composition steps and share declaration metadata and scalar argument admission.

The language reference covers grammar and scope; the word tutorial and CSV examples develop full queries. The published Rust API describes registry 0.3.0. Run cargo doc --open for local API documentation. Reader forms and Rust enum variants are not interchangeable: for example, there is no ordinary array(...) call, and nominal member construction needs a host resolver.

Alphabetical index

Each spelling links to its detailed entry. Symbols are listed first, followed by names; aliases share entries. array, dict, keyed, record and tuple name literal/type forms, not ordinary calls. Entries marked native require host support. present is a pattern.

Name or form	Reference
!=	Operators and access
*	Operators and access
+	Operators and access
++	Strings
-	Operators and access
.	Operators and access
..	Operators and access
/	Operators and access
/\	Operators and access
<	Operators and access
<=	Operators and access
=	Operators and access
==	Operators and access
>	Operators and access
>=	Operators and access
[]	Operators and access
\/	Operators and access
|	Operators and access
absent	Presence and lookup
align	Grouping and neighbourhoods
and	Operators and access
array	Collections and reductions
axes	Collections and reductions
bind	Shared native forms
break	Functions and control flow
case	Collections and reductions
check	Collection pipeline stages
contains	Strings
continue	Functions and control flow
count	Collection pipeline stages
default	Presence and lookup
dict	Collections and reductions
div	Operators and access
else	Functions and control flow
elseif	Functions and control flow
endif	Functions and control flow
ends_with	Strings
entries	Collections and reductions
except	Shared native forms
exists	Collections and reductions
f"..."	F-strings
filter	Collection pipeline stages
fixpoint	Shared native forms
flat_map	Collection pipeline stages
fn	Functions and control flow
fold	Functions and control flow
for	Collections and reductions
forall	Collections and reductions
format	Scalars and strings
from	Shared native forms
function call	Functions and control flow
group_by	Grouping and neighbourhoods
has_key	Presence and lookup
head	Collection pipeline stages
identity_set	Queues and native identity sets
if	Functions and control flow
in	Operators and access
index_set	Collections and reductions
input	Shared native forms
insert	Queues and native identity sets
intersect	Shared native forms
keyed	Collections and reductions
length	Collections and reductions
let	Functions and control flow
lookup	Presence and lookup
loop	Functions and control flow
map	Collection pipeline stages
map_by	Shared native forms
match (value)	Functions and control flow
match {captures}	Shared native forms
max	Ordering and extrema
max_all	Ordering and extrema
max_all_by	Ordering and extrema
max_by	Ordering and extrema
min	Ordering and extrema
min_all	Ordering and extrema
min_all_by	Ordering and extrema
min_by	Ordering and extrema
mod	Operators and access
not	Operators and access
occurs	Presence and lookup
one	Collections and reductions
or	Operators and access
param	Functions and control flow
parse_float	Scalars and strings
parse_int	Scalars and strings
paths	Shared native forms
pop_front	Queues and native identity sets
present	Presence and lookup
project	Shared native forms
push_back_all	Queues and native identity sets
queue	Queues and native identity sets
record	Collections and reductions
render_json (Rust)	JSON rendering
render_json_value (Rust)	JSON rendering
render_markdown (Rust)	Markdown rendering
render_report_markdown (Rust)	Mixed Markdown reports
report	Functions and control flow
require	Presence and lookup
reverse	Collection pipeline stages
runs_by	Grouping and neighbourhoods
scan	Functions and control flow
set	Collections and reductions
sort	Ordering and extrema
sort_by	Ordering and extrema
starts_with	Strings
sum	Collections and reductions
tail	Collection pipeline stages
tally	Collection pipeline stages
to_json_value (Rust)	JSON rendering
to_report_json_value (Rust)	Mixed native reports
to_string	Scalars and strings
tuple	Collections and reductions
union	Shared native forms
unique	Collection pipeline stages
where	Collections and reductions
where_exists	Shared native forms
windows	Grouping and neighbourhoods
with	Operators and access
zip_exact	Collections and reductions