From 9d20e201f3a924179a801fdb0543e23909065348 Mon Sep 17 00:00:00 2001 From: Ryan Avella Date: Thu, 14 Dec 2023 21:40:00 -0800 Subject: [PATCH] Document order guarantees for Itertools adapters. --- src/lib.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index f3b6e807d..60392fb96 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -407,6 +407,12 @@ macro_rules! chain { /// return a regular value of some other kind. /// [`.next_tuple()`](Itertools::next_tuple) is an example and the first regular /// method in the list. +/// +/// # Guarantees +/// +/// Given deterministic inputs, all iterator adapters currently yield items +/// in a predictable order. This order is considered observable and is therefore +/// intended to remain stable across releases that share the same major version. pub trait Itertools: Iterator { // adaptors