Crate caracat

caracat

caracat (always in lowercase) is a port of caracal from C++ to Rust.

The initial motivation was to benefit from a saner build system to make the project easier to maintain. The architecture is very similar between the two projects and the input/output format is the same.

Two example binaries are provided:

# Implementation of caracal command-line interface
cargo run --example caracal -- --help
# (Partial) implementation of yarrp
cargo run --example yarrp -- --help

For more information, please refer to the caracal documentation and to the API documentation.

Re-exports

• pub use checksum::*;
• pub use prober::*;
• pub use receiver::*;
• pub use sender::*;
• pub use tree::*;

Modules

• builder
  Functions for building probe packets.
• checksum
  Functions for computing the caracat checksum.
• easy
  High-level interface for sending probes and capturing replies.
• logger
  Utilities for logging probing statistics.
• models
  Data structures for representing probes and replies.
• neighbors
  Find routes and resolve link-layer addresses.
• parser
  Function for parsing replies.
• prober
  High-level interface for sending probes.
• rate_limiter
  Limit the rate at which packets are sent.
• receiver
  High-level interface for capturing replies.
• sender
  Send probes on the network.
• timestamp
  Utilities for encoding timestamps in probe packets.
• tree
  Data structures for filtering IP addresses.
• utilities
  Utilities.