Expand description
Protocol-first APRS engine core primitives.
The codec boundary accepts untrusted bytes, preserves them exactly, and fails closed when the packet shape is malformed.
Structs§
- Accepted
Packet Event - Accepted packet observability event.
- Capability
- APRS station capabilities packet bytes.
- Compressed
Position - Compressed APRS position fields.
- Coordinates
- Decimal coordinates in signed degrees.
- Counters
- Runtime counters.
- Engine
- Parser and policy orchestration engine.
- Error
Diagnostic - Structured diagnostic metadata for parser, policy, and transport errors.
- Item
- APRS item report fields.
- Line
Transport - Line-oriented packet source for file/stdin style transports.
- Maidenhead
- APRS Maidenhead locator packet bytes.
- Malformed
Packet Event - Codec-malformed packet observability event.
- Message
- APRS message fields.
- MicE
- APRS Mic-E packet bytes.
- MicE
Speed Course - Mic-E speed/course extension.
- Nmea
- APRS NMEA packet bytes.
- Nmea
Checksum - NMEA checksum validation details.
- Object
- APRS object report fields.
- Packet
Summary - Structured packet diagnostic summary.
- Parse
Options - Codec configuration for consumers that need a different envelope limit.
- Parsed
Packet - Structured packet view backed by the preserved raw packet bytes.
- Policy
- Policy options applied after parsing.
- Policy
Rejected Packet Event - Policy-rejected packet observability event.
- Position
- Uncompressed APRS position fields.
- Query
- APRS query packet bytes.
- RawPacket
- Original packet bytes retained without normalization or lossy conversion.
- Support
Item - Support-matrix item exposed for documentation and machine-readable CLI output.
- Support
Matrix - Machine-readable support matrix for operator tooling and docs.
- Telemetry
- APRS telemetry report fields.
- Telemetry
Metadata - APRS telemetry metadata packet carried in an APRS message.
- Third
Party - APRS third-party traffic packet bytes.
- Timestamped
Position - Timestamped uncompressed APRS position fields.
- Transport
Failure Event - Transport failure observability event.
- Transport
Support - Transport adapter support entry.
- User
Defined - APRS user-defined packet fields.
- Weather
- APRS weather report bytes.
- Weather
Fields - Extracted numeric weather fields.
Enums§
- Aprs
Data - Semantic APRS information-field data.
- Data
Type Identifier - APRS data type identifier from the first payload byte.
- Diagnostic
Layer - Stable diagnostic layer for parser, policy, and transport failures.
- Engine
Event - Engine processing event for accepted, rejected, or malformed packets.
- Engine
Event Kind - Stable engine event category for observability.
- Engine
Result - Engine processing result.
- Message
Kind - APRS message subtype.
- MicE
Message Code - Mic-E destination-derived message code.
- MicE
Standard Message - Standard Mic-E message code.
- MicE
Status - Mic-E destination-derived status bits.
- Parse
Error - Fail-closed packet parse errors.
- Policy
Decision - Policy decision.
- Policy
Rejection - Policy rejection reason.
- Support
Status - Support status for documented APRS capabilities and integration surfaces.
- Telemetry
Metadata Kind - APRS telemetry metadata subtype.
- Transport
Error Code - Stable transport diagnostic categories for logs and external systems.
Constants§
- DEFAULT_
PARSE_ OPTIONS - Default parse options used by
parse_packet. - DEFAULT_
TRANSPORT_ READ_ LIMIT - Default maximum byte batch accepted by transport helper readers.
- EVENT_
RAW_ BYTE_ LIMIT - Maximum raw bytes copied into malformed packet observability events.
- MAX_
PACKET_ LEN - Conservative upper bound for an APRS packet handled by this skeleton.
Traits§
- Packet
Sink - Common packet-sink contract for transport adapters.
- Packet
Source - Common packet-source contract for transport adapters.
Functions§
- oversized_
input_ error - Creates the standard oversized-input transport error.
- parse_
packet - Parses an APRS packet from untrusted bytes.
- parse_
packet_ with_ options - Parses an APRS packet from untrusted bytes with explicit codec options.
- read_
all_ with_ limit - Reads all available bytes from a reader while enforcing a hard limit.
- support_
matrix - Returns the current support matrix for CLI and documentation consumers.