From 0162f5f462789aa613f1b8edce202531d492b055 Mon Sep 17 00:00:00 2001
From: Jiahao XU <Jiahao_XU@outlook.com>
Date: Sat, 11 Jun 2022 22:53:34 +1000
Subject: [PATCH] Add doc for `TarEntriesVisitor`

Signed-off-by: Jiahao XU <Jiahao_XU@outlook.com>
---
 src/helpers/extracter.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/helpers/extracter.rs b/src/helpers/extracter.rs
index 1175da8a..78d858c3 100644
--- a/src/helpers/extracter.rs
+++ b/src/helpers/extracter.rs
@@ -11,6 +11,8 @@ use zstd::stream::Decoder as ZstdDecoder;
 
 use crate::{BinstallError, TarBasedFmt};
 
+/// Visitor must iterate over all entries.
+/// Entires can be in arbitary order.
 pub trait TarEntriesVisitor {
     fn visit<R: Read>(&mut self, entries: Entries<'_, R>) -> Result<(), BinstallError>;
 }