rercon/
lib.rs

1//! ReRCON is a RCON library written with primarily the game Ark: Survival Evolved in mind.
2//! While this library is Valve RCON compliant, and should thus work with other RCON applications, it has not been tested for other applications.
3//!
4//! There are two primary types to be used with this create,
5//! [`Connection`](struct.Connection.html) and [`ReConnection`](struct.ReConnection.html),
6//! both of these types share the same API,
7//! the primary difference is that [`ReConnection::exec`](struct.ReConnection.html#method.exec) will never return [`IO errors`](enum.Error.html#variant.IO),
8//! as it will start a new thread to reconnect,
9//! instead, it will return error [`BusyReconnecting`](enum.Error.html#variant.BusyReconnecting),
10//! with a string being a `to_string` representation of the error that caused the reconnect in the first place.
11//!
12//! All public methods use a template to accept all forms of strings that implement `Into<String>`, however the library will always return `std::string::String`
13
14#![deny(warnings, bad_style, missing_docs)]
15
16pub use crate::connection::Settings;
17pub use crate::connection::SingleConnection as Connection;
18pub use crate::error::RconError as Error;
19#[cfg(feature = "reconnection")]
20pub use crate::reconnect::ReconnectingConnection as ReConnection;
21
22mod connection;
23mod error;
24mod packet;
25mod packet_net;
26#[cfg(feature = "reconnection")]
27mod reconnect;
28
29#[cfg(test)]
30mod tests;