summaryrefslogtreecommitdiff
path: root/rust/src/platform.rs
diff options
context:
space:
mode:
authorMason Reed <mason@vector35.com>2026-03-13 12:19:41 -0700
committerMason Reed <35282038+emesare@users.noreply.github.com>2026-03-24 18:46:48 -0700
commit938e9506996df13b3f08419854aa73c7d24f2d44 (patch)
treefe86a80be40e2ae2db4e4f34eebfeccd1672bd8b /rust/src/platform.rs
parent61e4e7e772b9c427bf190f8557afc466d0488848 (diff)
[Rust] Misc docs
Diffstat (limited to 'rust/src/platform.rs')
-rw-r--r--rust/src/platform.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/rust/src/platform.rs b/rust/src/platform.rs
index 46129b81..bf135fae 100644
--- a/rust/src/platform.rs
+++ b/rust/src/platform.rs
@@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-//! Contains all information related to the execution environment of the binary, mainly the calling conventions used
+//! A [`Platform`] models the information related to the execution environment of the binary.
use crate::{
architecture::{Architecture, CoreArchitecture},
@@ -29,6 +29,8 @@ use std::fmt::Debug;
use std::ptr::NonNull;
use std::{borrow::Borrow, ffi, ptr};
+/// A platform describes the target [`CoreArchitecture`] and platform-specific information such as
+/// the calling conventions and generic types (think `HRESULT` on Windows).
#[derive(PartialEq, Eq, Hash)]
pub struct Platform {
pub(crate) handle: *mut BNPlatform,