From 8a66d88d33253bce6f1efc278abe805575e81c1d Mon Sep 17 00:00:00 2001 From: KyleMiles Date: Wed, 31 Aug 2022 15:39:41 -0400 Subject: Rust API : Major docs update (still need detailed module and function documentation) --- rust/src/binaryview.rs | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'rust/src/binaryview.rs') diff --git a/rust/src/binaryview.rs b/rust/src/binaryview.rs index 311e867e..a372b778 100644 --- a/rust/src/binaryview.rs +++ b/rust/src/binaryview.rs @@ -12,6 +12,11 @@ // See the License for the specific language governing permissions and // limitations under the License. +//! A view on binary data and queryable interface of a binary file. +//! +//! One key job of BinaryView is file format parsing which allows Binary Ninja to read, write, insert, remove portions of the file given a virtual address. For the purposes of this documentation we define a virtual address as the memory address that the various pieces of the physical file will be loaded at. +//! TODO : Mirror the Python docs for this + use binaryninjacore_sys::*; pub use binaryninjacore_sys::BNModificationStatus as ModificationStatus; -- cgit v1.3.1