add doc to a bit more

This commit is contained in:
Lily Tsuru 2024-12-02 03:27:59 -05:00
parent ec1649197c
commit f04338fd2b

View file

@ -1,3 +1,4 @@
//! Hazelnut C++ client bindings.
use std::ffi; use std::ffi;
pub(crate) mod sys { pub(crate) mod sys {
@ -6,8 +7,13 @@ pub(crate) mod sys {
#[repr(u32)] #[repr(u32)]
#[allow(unused)] // it IS used, just not by Rust #[allow(unused)] // it IS used, just not by Rust
pub enum ResultCode { pub enum ResultCode {
/// The frame has not been changed. (This is implemented internally by comparing the frame serial; if it has changed then the frame has too)
Unchanged, Unchanged,
/// The frame has been changed.
Changed, Changed,
/// A failure occured during the tick.
Fail, Fail,
} }