deprecate `pub fn cs`, which is an intensely embarrassing bug of a function

unlike every other function to test if a particular selector is picked
by prefixes, `Prefixes::cs` does not return bool, nor does it check the
currently-selected prefix. instead, it modifies the decoded `Prefixes`
to set the current prefix to `cs`.

this has been a bug all the way since 0.0.1 was released. the function
now does nothing, and is marked deprecated.

in a future 2.x release, the function will be changed to return `bool`
and be in-line with other segment selector-checking functions. in the
mean time, a new `Prefixes::selects_cs()` does the correct thing.

thank you to @meithecatte who pointed this out in
https://github.com/iximeow/yaxpeax-x86/issues/28!

1 files changed, 4 insertions, 1 deletions

diff --git a/src/long_mode/mod.rs b/src/long_mode/mod.rs
index 6412afb..a89d673 100644
--- a/src/long_mode/mod.rs
+++ b/src/long_mode/mod.rs
@@ -4557,8 +4557,11 @@ impl Prefixes {
     fn set_lock(&mut self) { self.bits |= 0x4 }
     #[inline]
     pub fn lock(&self) -> bool { self.bits & 0x4 == 4 }
+    #[deprecated(since = "0.0.1", note = "pub fn cs has never returned `bool` indicating the current selector is `cs`. use `selects_cs` for this purpose, until 2.x that will correct `pub fn cs`.")]
     #[inline]
-    pub fn cs(&mut self) { self.segment = Segment::CS }
+    pub fn cs(&mut self) {}
+    #[inline]
+    pub fn selects_cs(&self) -> bool { self.segment == Segment::CS }
     #[inline]
     pub fn ds(&self) -> bool { self.segment == Segment::DS }
     #[inline]