mirror of
https://git.robbyzambito.me/zaprus
synced 2026-02-04 08:24:52 +00:00
Clean API and add docs
This commit is contained in:
14
src/root.zig
14
src/root.zig
@@ -14,14 +14,16 @@
|
||||
// You should have received a copy of the GNU General Public License along with
|
||||
// Zaprus. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
//! The Zaprus library is useful for implementing clients that interact with the [Saprus Protocol](https://gitlab.com/c2-games/red-team/saprus).
|
||||
//!
|
||||
//! The main entrypoint into this library is the `Client` type.
|
||||
//! It can be used to send fire and forget messages, and establish persistent connections.
|
||||
//! It is up to the consumer of this library to handle non-management message payloads.
|
||||
//! The library handles management messages automatically (right now, just ping).
|
||||
|
||||
pub const Client = @import("Client.zig");
|
||||
pub const Connection = @import("Connection.zig");
|
||||
|
||||
const msg = @import("message.zig");
|
||||
|
||||
pub const MessageTypeError = msg.MessageTypeError;
|
||||
pub const MessageParseError = msg.MessageParseError;
|
||||
pub const Message = msg.Message;
|
||||
pub const Message = @import("message.zig").Message;
|
||||
|
||||
test {
|
||||
@import("std").testing.refAllDecls(@This());
|
||||
|
||||
Reference in New Issue
Block a user