diff options
Diffstat (limited to 'rust/src/platform.rs')
| -rw-r--r-- | rust/src/platform.rs | 4 |
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, |