summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyleMiles <krm504@nyu.edu>2023-01-05 15:29:09 -0500
committerKyleMiles <krm504@nyu.edu>2023-01-06 16:29:56 -0500
commit52edc39a7081fd6662e14fbcd473adabbbc36c7a (patch)
tree2901f70389dcd6e9f69aa453ba7125c5cd0cbf0d
parent0f530dd41bee6ed057567c42c7ae92fd474364c8 (diff)
Cargo doc fixes
-rw-r--r--rust/src/binaryview.rs2
-rw-r--r--rust/src/lib.rs2
-rw-r--r--rust/src/types.rs12
3 files changed, 10 insertions, 6 deletions
diff --git a/rust/src/binaryview.rs b/rust/src/binaryview.rs
index c14636de..ad9a0fc9 100644
--- a/rust/src/binaryview.rs
+++ b/rust/src/binaryview.rs
@@ -794,7 +794,7 @@ pub trait BinaryViewExt: BinaryViewBase {
/// Get a tag type by its name.
///
- /// Shorthand for [get_tag_type_by_name].
+ /// Shorthand for [Self::get_tag_type_by_name].
fn get_tag_type<S: BnStrCompatible>(&self, name: S) -> Option<Ref<TagType>> {
self.get_tag_type_by_name(name)
}
diff --git a/rust/src/lib.rs b/rust/src/lib.rs
index 42d211b8..19414a22 100644
--- a/rust/src/lib.rs
+++ b/rust/src/lib.rs
@@ -31,7 +31,7 @@
//!
//! > ⚠️ **These bindings are in a very early beta, only have partial support for the core APIs and are still actively under development. Compatibility _will_ break and conventions _will_ change! They are being used for core Binary Ninja features however, so we expect much of what is already there to be reliable enough to build on, just don't be surprised if your plugins/scripts need to hit a moving target.**
//!
-//! > ⚠️ This project runs on Rust version `stable-2022-04-07`
+//! > ⚠️ This project runs on Rust version `stable-2022-12-15`
//!
//! ---
//!
diff --git a/rust/src/types.rs b/rust/src/types.rs
index eac2e7d1..c7f55b8f 100644
--- a/rust/src/types.rs
+++ b/rust/src/types.rs
@@ -81,8 +81,9 @@ impl<T> Conf<T> {
}
}
-/// Conf<T> + Conf<T> ==> Conf<T>
/// Returns best value or LHS on tie
+///
+/// `Conf<T>` + `Conf<T>` → `Conf<T>`
impl<T> ConfMergable<T, Conf<T>> for Conf<T> {
type Result = Conf<T>;
fn merge(self, other: Conf<T>) -> Conf<T> {
@@ -94,8 +95,9 @@ impl<T> ConfMergable<T, Conf<T>> for Conf<T> {
}
}
-/// Conf<T> + Option<Conf<T>> ==> Conf<T>
/// Returns LHS if RHS is None
+///
+/// `Conf<T>` + `Option<Conf<T>>` → `Conf<T>`
impl<T> ConfMergable<T, Option<Conf<T>>> for Conf<T> {
type Result = Conf<T>;
fn merge(self, other: Option<Conf<T>>) -> Conf<T> {
@@ -106,8 +108,9 @@ impl<T> ConfMergable<T, Option<Conf<T>>> for Conf<T> {
}
}
-/// Option<Conf<T>> + Conf<T> ==> Conf<T>
/// Returns RHS if LHS is None
+///
+/// `Option<Conf<T>>` + `Conf<T>` → `Conf<T>`
impl<T> ConfMergable<T, Conf<T>> for Option<Conf<T>> {
type Result = Conf<T>;
fn merge(self, other: Conf<T>) -> Conf<T> {
@@ -118,8 +121,9 @@ impl<T> ConfMergable<T, Conf<T>> for Option<Conf<T>> {
}
}
-/// Option<Conf<T>> + Option<Conf<T>> ==> Option<Conf<T>>
/// Returns best non-None value or None
+///
+/// `Option<Conf<T>>` + `Option<Conf<T>>` → `Option<Conf<T>>`
impl<T> ConfMergable<T, Option<Conf<T>>> for Option<Conf<T>> {
type Result = Option<Conf<T>>;
fn merge(self, other: Option<Conf<T>>) -> Option<Conf<T>> {