aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authori509VCB <i509vcb@gmail.com>2021-10-10 18:09:25 +0000
committerGitHub <noreply@github.com>2021-10-10 11:09:25 -0700
commitd11b7323a5c5442372450566fe713f94b5e34342 (patch)
treed16e256f114d837e97551309d86ef09c1b4cfcee /src
parentd4620aedb1e085462f82d2a643a20c7de743ea2b (diff)
export `InstructionDisplayer` (#9)
This makes generated docs refer to a type and show said type in the list of all structs rather than rustdoc showing gray text in return types. quote doc references
Diffstat (limited to 'src')
-rw-r--r--src/long_mode/display.rs2
-rw-r--r--src/long_mode/mod.rs2
-rw-r--r--src/protected_mode/display.rs2
-rw-r--r--src/protected_mode/mod.rs2
-rw-r--r--src/real_mode/display.rs2
-rw-r--r--src/real_mode/mod.rs2
6 files changed, 9 insertions, 3 deletions
diff --git a/src/long_mode/display.rs b/src/long_mode/display.rs
index 181217c..56c4ebd 100644
--- a/src/long_mode/display.rs
+++ b/src/long_mode/display.rs
@@ -3272,6 +3272,8 @@ pub enum DisplayStyle {
// ATT,
}
+/// Implementation of [`Display`](fmt::Display) that renders instructions using a specified display
+/// style.
pub struct InstructionDisplayer<'instr> {
pub(crate) instr: &'instr Instruction,
pub(crate) style: DisplayStyle,
diff --git a/src/long_mode/mod.rs b/src/long_mode/mod.rs
index 1499f98..3d6d977 100644
--- a/src/long_mode/mod.rs
+++ b/src/long_mode/mod.rs
@@ -7,7 +7,7 @@ pub mod uarch;
pub use crate::MemoryAccessSize;
#[cfg(feature = "fmt")]
-pub use self::display::DisplayStyle;
+pub use self::display::{DisplayStyle, InstructionDisplayer};
use core::cmp::PartialEq;
use core::hint::unreachable_unchecked;
diff --git a/src/protected_mode/display.rs b/src/protected_mode/display.rs
index dac3684..0a8f775 100644
--- a/src/protected_mode/display.rs
+++ b/src/protected_mode/display.rs
@@ -3285,6 +3285,8 @@ pub enum DisplayStyle {
// ATT,
}
+/// Implementation of [`Display`](fmt::Display) that renders instructions using a specified display
+/// style.
pub struct InstructionDisplayer<'instr> {
pub(crate) instr: &'instr Instruction,
pub(crate) style: DisplayStyle,
diff --git a/src/protected_mode/mod.rs b/src/protected_mode/mod.rs
index 5ad4c44..fef1807 100644
--- a/src/protected_mode/mod.rs
+++ b/src/protected_mode/mod.rs
@@ -7,7 +7,7 @@ pub mod uarch;
pub use crate::MemoryAccessSize;
#[cfg(feature = "fmt")]
-pub use self::display::DisplayStyle;
+pub use self::display::{DisplayStyle, InstructionDisplayer};
use core::cmp::PartialEq;
use core::hint::unreachable_unchecked;
diff --git a/src/real_mode/display.rs b/src/real_mode/display.rs
index 1065255..d82e54e 100644
--- a/src/real_mode/display.rs
+++ b/src/real_mode/display.rs
@@ -3285,6 +3285,8 @@ pub enum DisplayStyle {
// ATT,
}
+/// Implementation of [`Display`](fmt::Display) that renders instructions using a specified display
+/// style.
pub struct InstructionDisplayer<'instr> {
pub(crate) instr: &'instr Instruction,
pub(crate) style: DisplayStyle,
diff --git a/src/real_mode/mod.rs b/src/real_mode/mod.rs
index 6eefdad..45dd7a3 100644
--- a/src/real_mode/mod.rs
+++ b/src/real_mode/mod.rs
@@ -7,7 +7,7 @@ pub mod uarch;
pub use crate::MemoryAccessSize;
#[cfg(feature = "fmt")]
-pub use self::display::DisplayStyle;
+pub use self::display::{DisplayStyle, InstructionDisplayer};
use core::cmp::PartialEq;
use core::hint::unreachable_unchecked;