From d725707b5ad3e230c4cdc8c124d55b6ad4caffc3 Mon Sep 17 00:00:00 2001 From: Maxime Mouchet Date: Wed, 24 Aug 2022 10:38:19 +0200 Subject: [PATCH] documentation --- Cargo.lock | 2 +- src/atlas/mod.rs | 4 ++++ src/warts_trace/mod.rs | 5 +++++ src/warts_trace/to.rs | 1 + 4 files changed, 11 insertions(+), 1 deletion(-) diff --git a/Cargo.lock b/Cargo.lock index 3e80896..603a4e0 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -308,7 +308,7 @@ checksum = "9ff7415e9ae3fff1225851df9e0d9e4e5479f947619774677a63572e55e80eff" [[package]] name = "pantrace" -version = "0.4.0" +version = "0.5.0" dependencies = [ "anyhow", "chrono", diff --git a/src/atlas/mod.rs b/src/atlas/mod.rs index 7d453ee..45c3378 100644 --- a/src/atlas/mod.rs +++ b/src/atlas/mod.rs @@ -1,4 +1,8 @@ //! RIPE Atlas newline-delimited JSON format. +//! +//! This format is obtained by passing the `format=txt` parameter to the RIPE Atlas API. +//! For example: +//! [https://atlas.ripe.net/api/v2/measurements/23119200/results/?start=1625097600&stop=1625788799&probe_ids=6479&format=txt](https://atlas.ripe.net/api/v2/measurements/23119200/results/?start=1625097600&stop=1625788799&probe_ids=6479&format=txt) mod from; mod models; mod reader; diff --git a/src/warts_trace/mod.rs b/src/warts_trace/mod.rs index 11f88a9..154b746 100644 --- a/src/warts_trace/mod.rs +++ b/src/warts_trace/mod.rs @@ -1,4 +1,9 @@ //! Scamper's warts format with trace objects. +//! +//! This format is typically used for [CAIDA's Ark](https://www.caida.org/projects/ark/) data. +//! +//! The [warts](https://github.com/dioptra-io/warts) library is used to read and write the +//! [`warts(5)`](https://www.caida.org/catalog/software/scamper/man/warts.5.pdf) files. mod from; mod reader; mod to; diff --git a/src/warts_trace/to.rs b/src/warts_trace/to.rs index 796163b..7d3ca8c 100644 --- a/src/warts_trace/to.rs +++ b/src/warts_trace/to.rs @@ -5,6 +5,7 @@ use std::net::Ipv6Addr; use std::ops::Add; use warts::{Address, Timeval, TraceProbe, TraceType, Traceroute}; +/// Build an array of [TracerouteReply] from a [Traceroute]. pub fn warts_trace_to_internal( traceroute: &Traceroute, cycle_id: u32,