Stability

This crate is currently pre-1.0. We will do our best to minimize breaking changes to the library, but there is still many parts of the cat-dev we have not fully figured out. As such we're very hesitant to make any promises about the stability of these APIs, or that we'll follow SEM-VER until we've at the very least figured all of that out. If you are ever affected by this, or concerned about this please reach out on our codeberg repository. We do want to try, and make it as smooth as possible.

Usage

The crate offers a very simple API, capable of sending commands (and not reading the response back as the telnet server has no way of identifying when the 'end' of a response is), and receiving FULL lines from the input.

use cat_dev_telnet::TelnetStream;
use std::time::Duration;

const TIMEOUT_FOR_CONNECT: Duration = Duration::from_secs(30);
const TIMEOUT_FOR_WAITING_FOR_A_LINE: Duration = Duration::from_secs(3);

let stream = TelnetStream::connect(
	"192.168.1.1:23",
	TIMEOUT_FOR_CONNECT,
).await.expect("Failed to connect to telnet for MION device at 192.168.1.1");
// `connect()` will not only open a telnet session but log you into the device.
//
// From there all we need to do is use it!
stream.send("dump_dsata_trace").await.expect("Failed to send `dump_dsata_trace` command!");
while let Ok(line) = stream.recv_line(TIMEOUT_FOR_WAITING_FOR_A_LINE).await {
	println!("Got line: [{line}]")
}