API Reference

This page documents the public API exposed by the top-level wingfoil module. See the User Guide for narrative examples covering every operator and I/O adapter below.

Quick index

Sources: ticker(), constant().

Composition: bimap(), Graph, CustomStream.

Core types: Stream, Node.

Stream operators (methods on Stream ):

map, filter, distinct, difference, delay, not, limit, sample, count, sum, average, buffer, collect, with_time, dataframe, inspect, logged, for_each, finally, peek_value, run.

Pandas helpers: to_dataframe(), build_dataframe().

I/O adapters:

  • CSV — csv_read(); Stream.csv_write(path).

  • KDB+ — kdb_read(), kdb_write(); Stream.kdb_write(...).

  • etcd — etcd_sub(); Stream.etcd_pub(endpoint, lease_ttl=None, force=True).

  • ZeroMQ — zmq_sub(), zmq_sub_etcd(); Stream.zmq_pub(port), Stream.zmq_pub_etcd(name, port, endpoint), Stream.zmq_pub_etcd_on(name, address, port, endpoint).

  • iceoryx2 (feature-gated) — iceoryx2_sub(), Iceoryx2ServiceVariant, Iceoryx2Mode; Stream.iceoryx2_pub(service_name, variant, history_size, initial_max_slice_len).

  • FIX 4.4 — fix_connect(), fix_connect_tls(), fix_accept().

  • Prometheus — PrometheusExporter.

  • OpenTelemetry OTLP — Stream.otlp_push(metric_name, endpoint, service_name).

Generated reference

The table below is auto-generated by sphinx-autosummary and links to per-member pages with full signatures and docstrings.

wingfoil

Wingfoil is a blazingly fast, highly scalable stream processing framework designed for latency-critical use cases such as electronic trading and real-time AI systems