API Reference

CLI

Command Reference — every flag, option, and example for send, receive, and discover.

Rust Library

Advanced Integration — embed the hayate engine in your Rust project with builder APIs and low-level module access.

Core types

Type	Module	Description
`HayateSender`	`hayate::runner`	Builder for sending files/directories
`HayateReceiver`	`hayate::runner`	Builder for receiving files/directories
`EngineError`	`hayate::error`	Top-level error enum
`Metadata`	`hayate::protocol`	Transfer metadata (filename, size, hash algo)
`BufferPool`	`hayate::pool`	Thread-safe zero-alloc buffer leasing

Public modules

Module	Purpose
`hayate::runner`	High-level sender/receiver builders
`hayate::transfer`	Handshake and payload pipelines
`hayate::protocol`	Wire format constants and codecs
`hayate::crypto`	Key exchange, HKDF, AEAD
`hayate::network`	QUIC endpoint and TLS config
`hayate::discovery`	mDNS + UDP peer discovery
`hayate::tar`	Streaming archive pack/extract
`hayate::error`	Error types