# Crafter Examples
This directory is the authoritative map of the user-facing `crafter` examples.
Every example uses only public APIs from the `crafter` crate, with
`crafter::prelude::*` used unless a narrower import keeps the example clearer.
IPv4 and IPv6 examples use versioned layer names, and known IPv4 protocol-field
values use `Ipv4Protocol`.
## Safety Legend
- Offline: builds, decodes, inspects, reads, or writes generated data without
opening live network handles.
- Dry-run: builds send or send/receive plans and reports without transmitting
packets.
- Live-gated: defaults to a safe plan or dry-run and opens live send or capture
handles only after the wire endpoint guard is satisfied.
| `hello_world` | Core packet model | Offline | IPv4, ICMP, Raw construction, compile, summary, and hexdump output. | `cargo run -p crafter --example hello_world` |
| `packet_building` | Core packet model | Offline | Builder-style packet composition, typed field setting, and deterministic compile output. | `cargo run -p crafter --example packet_building` |
| `packet_inspection` | Core packet model | Offline | Typed layer access, mutation before compile, packet summaries, and detailed inspection output. | `cargo run -p crafter --example packet_inspection` |
| `decode_bytes` | Core packet model | Offline | Decode from link, network, and IPv4 entry points while preserving raw payloads. | `cargo run -p crafter --example decode_bytes` |
| `custom_registry` | Core packet model | Offline | Protocol registry customization and default decode comparison. | `cargo run -p crafter --example custom_registry` |
| `send_plan` | Net workflows | Dry-run | Network-layer send planning, compiled bytes, targets, and derived reply filters. | `cargo run -p crafter --example send_plan` |
| `send_packet` | Net workflows | Dry-run by default; live-gated with `--live` | Network-layer and link-layer send reports using dry-run options by default. | `cargo run -p crafter --example send_packet` |
| `send_recv_icmp` | Net workflows | Dry-run | ICMP send/receive configuration, retry timing, filters, and dry-run reports. | `cargo run -p crafter --example send_recv_icmp` |
| `network_ping` | Net workflows | Dry-run by default; live-gated with `--live` | Network-layer ICMP echo send/receive for disposable wire endpoint smoke tests. | `cargo run -p crafter --example network_ping` |
| `reply_matching` | Net workflows | Offline | Synthetic request/reply matching and generated reply filters. | `cargo run -p crafter --example reply_matching` |
| `batch_send` | Net workflows | Dry-run | Positional batch send reports for multiple TCP packets. | `cargo run -p crafter --example batch_send` |
| `batch_send_recv` | Net workflows | Dry-run | Batch send/receive reports across IPv4 and IPv6 requests. | `cargo run -p crafter --example batch_send_recv` |
| `interface_helpers` | Net workflows | Offline | Documentation-safe interface metadata and address helper output. | `cargo run -p crafter --example interface_helpers` |
| `ip_ranges` | Net workflows | Offline | IPv4 CIDR, range, and list parsing. | `cargo run -p crafter --example ip_ranges` |
| `pcap_write` | Pcap and sniffing | Offline | Generated Ethernet/IPv4/TCP packets written to a pcap file. | `cargo run -p crafter --example pcap_write` |
| `pcap_read` | Pcap and sniffing | Offline | Pcap metadata inspection through `PacketWire` and `Sniffer`. | `cargo run -p crafter --example pcap_read` |
| `wire_pcap_sniffer` | Pcap and sniffing | Offline | Generated pcap records read through `PacketWire` and `Sniffer` with packet metadata. | `cargo run -p crafter --example wire_pcap_sniffer` |
| `wire_pcap_recorder` | Pcap and sniffing | Offline | Generated packet records written through `PacketWire` and `Transmitter`, then verified through pcap readback. | `cargo run -p crafter --example wire_pcap_recorder` |
| `wire_transform_chain` | Pcap and sniffing | Offline | In-memory `Sniffer` transform chain with zero, one, and many packet-record outputs. | `cargo run -p crafter --example wire_transform_chain` |
| `ip_defrag_pcap_summary` | Pcap and sniffing | Offline | Pcap input run through `IpDefrag` with JSON artifact output containing payload hashes, defrag metadata, and transform traces. | `cargo run -p crafter --example ip_defrag_pcap_summary` |
| `ip_defrag_offline` | Pcap and sniffing | Offline | Generated memory fragments replayed through `IpDefrag` without opening a live interface. | `cargo run -p crafter --example ip_defrag_offline` |
| `ip_fragment_offline` | Pcap and sniffing | Offline | Documentation-addressed IPv6 packet fragmentation written to an in-memory writer. | `cargo run -p crafter --example ip_fragment_offline` |
| `wpa_decrypt_offline` | Pcap and sniffing | Offline | Synthetic WPA2-PSK CCMP pcap decryption through `PacketWire`, `Sniffer`, and `WpaDecrypt` with Wi-Fi/WPA metadata. | `cargo run -p crafter --example wpa_decrypt_offline` |
| `sniffer_offline` | Pcap and sniffing | Offline | Offline `Sniffer` filtering and bounded packet iteration. | `cargo run -p crafter --example sniffer_offline` |
| `capture_pcap` | Pcap and sniffing | Live-gated; plan by default | Bounded libpcap capture configuration and pcap writing on an isolated wire endpoint. | `cargo run -p crafter --example capture_pcap` |
| `arp_who_has` | Protocols | Dry-run | Explicit Ethernet broadcast ARP who-has construction from known MAC and IPv4 values. | `cargo run -p crafter --example arp_who_has` |
| `dns_query` | Protocols | Dry-run send/receive plus offline decode | DNS query construction, dry-run send/receive reporting, and synthetic response decoding. | `cargo run -p crafter --example dns_query -- --name example.com` |
| `dhcpv4_discover` | Protocols | Dry-run by default; live-gated with `--live` | DHCPv4 discover construction with an explicit client MAC and link-layer send options. | `cargo run -p crafter --example dhcpv4_discover` |
| `dhcpv4_option82` | Protocols | Offline | DHCPv4 relay agent information (option 82), classless static routes, and option overload construction and offline decode. | `cargo run -p crafter --example dhcpv4_option82` |
| `dhcpv4_leasequery` | Protocols | Offline | DHCPv4 leasequery, typed client identifier, authentication, and status/state packet-field construction and offline decode. | `cargo run -p crafter --example dhcpv4_leasequery` |
| `dhcpv6_solicit` | Protocols | Dry-run send/receive | DHCPv6 Solicit construction, option request data, derived reply filter, and network-layer send/receive planning. | `cargo run -p crafter --example dhcpv6_solicit` |
| `dhcpv6_information_request` | Protocols | Dry-run send/receive plus offline decode | DHCPv6 Information-request construction, dry-run send/receive reporting, decode, ORO inspection, and hexdump output. | `cargo run -p crafter --example dhcpv6_information_request` |
| `dhcpv6_prefix_delegation` | Protocols | Offline | DHCPv6 IA_PD and IA Prefix construction, compile, decode, and typed prefix inspection. | `cargo run -p crafter --example dhcpv6_prefix_delegation` |
| `dhcpv6_relay` | Protocols | Offline | DHCPv6 Relay-forward construction with Interface-Id and nested Relay Message decoding. | `cargo run -p crafter --example dhcpv6_relay` |
| `icmpv4_error` | Protocols | Offline | ICMPv4 time-exceeded error with a quoted datagram and an RFC 4884/4950 MPLS extension object, compiled and decoded offline. | `cargo run -p crafter --example icmpv4_error` |
| `icmpv6_echo` | Protocols | Offline by default; dry-run with `--send-recv` | IPv6 ICMPv6 echo construction and optional dry-run send/receive reporting. | `cargo run -p crafter --example icmpv6_echo` |
| `snmp_get` | Protocols | Offline | SNMPv1 and SNMPv2c GetRequest packet construction, decode, show, and hexdump output. | `cargo run -p crafter --example snmp_get` |
| `snmp_trap` | Protocols | Offline | SNMPv1 Trap and SNMPv2c SNMPv2-Trap packet construction, decode, show, and hexdump output. | `cargo run -p crafter --example snmp_trap` |
| `snmpv3_message` | Protocols | Offline | Synthetic SNMPv3 USM Report packet construction, decode, show, and hexdump output without credential storage. | `cargo run -p crafter --example snmpv3_message` |
| `vlan` | Protocols | Offline | 802.1Q VLAN frame construction, compile, and decode. | `cargo run -p crafter --example vlan` |
| `linux_sll` | Protocols | Offline | Linux cooked capture packet construction, compile, and decode. | `cargo run -p crafter --example linux_sll` |
| `null_loopback` | Protocols | Offline | BSD null/loopback link-layer packet construction, compile, and decode. | `cargo run -p crafter --example null_loopback` |
| `dot11_radiotap_ipv4` | Protocols | Offline | Radiotap/Dot11/LlcSnap/IPv4 construction, compile, decode, show, and hexdump output. | `cargo run -p crafter --example dot11_radiotap_ipv4` |
| `dot11_beacon_rsn` | Protocols | Offline | Bare Dot11 beacon construction with typed Rsn information element inspection. | `cargo run -p crafter --example dot11_beacon_rsn` |
| `eapol_key_parse` | Protocols | Offline | Synthetic Dot11/LlcSnap/Eapol-Key byte parsing with summary, show, and hexdump output. | `cargo run -p crafter --example eapol_key_parse` |
| `ipv4_enrichment` | Protocols | Offline | IPv4 DSCP/ECN helpers, typed options, checksum status, and fragment metadata inspection. | `cargo run -p crafter --example ipv4_enrichment` |
| `ipv4_options` | Protocols | Offline | IPv4 option builders with checksum and length auto-fill. | `cargo run -p crafter --example ipv4_options` |
| `tcp_options` | Protocols | Offline | TCP option builders, option ordering, and header-length auto-fill. | `cargo run -p crafter --example tcp_options` |
| `ipv6_extensions` | Protocols | Offline | IPv6 traffic class, flow label, options, routing, segment-routing, fragment, and raw next-header fallback decoding. | `cargo run -p crafter --example ipv6_extensions` |
Live-gated examples require all three opt-ins before opening live sockets or
capture handles: `--live`, `--i-understand-isolated-lab`, and
`LIBCRAFTER_ENDPOINT=1`.