Skip to content

Commit 2b8aa88

Browse files
committed
Add more documentation to the agent module
Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>
1 parent 0aefece commit 2b8aa88

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/agent.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
//! Traits for implementing custom SSH agents.
2+
//!
3+
//! Agents which store no state or their state is minimal should
4+
//! implement the [`Session`] trait. If a more elaborate state is
5+
//! needed, especially one which depends on the socket making the
6+
//! connection then it is advisable to implement the [`Agent`] trait.
27
38
use std::fmt;
49
use std::io;

0 commit comments

Comments
 (0)