From e16faf58cc1e47e431bbf110bf9cda0047909630 Mon Sep 17 00:00:00 2001 From: iximeow Date: Mon, 13 May 2024 23:07:39 -0700 Subject: fix cfg(!default,colors,serde) imports, doc comments --- CHANGELOG | 6 ++++++ src/annotation/mod.rs | 7 ++++++- src/color.rs | 4 +--- src/reader.rs | 2 +- 4 files changed, 14 insertions(+), 5 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index b80a7de..f57390d 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -4,8 +4,14 @@ TODO: Reader::next_n should return the number of items read as Err(ReadError::In TODO: Reader::offset should return an AddressDiff
, not a bare Address TODO: impls of `fn one` and `fn zero` so downstream users don't have to import num_traits directly +## 0.2.8 + added an impl of `From` for `StandardPartialDecoderError`, matching the existing `StandardDecodeError` impl. +moved a use of `serde` types to be covered by the relevant cfg flag; using `colors` without `serde` (unlikely) now actually builds. + +fixed up doc comments to build without error. + ## 0.2.7 moved `AnnotatingDecoder` and its associated types to `annotation/`, for module-level documentation about that feature. diff --git a/src/annotation/mod.rs b/src/annotation/mod.rs index 0139cf3..0248b94 100644 --- a/src/annotation/mod.rs +++ b/src/annotation/mod.rs @@ -19,6 +19,11 @@ //! in a generic setting, there isn't much to do with a `FieldDescription` other than display it. a //! typical use might look something like: //! ``` +//! use core::fmt; +//! +//! use yaxpeax_arch::annotation::{AnnotatingDecoder, VecSink}; +//! use yaxpeax_arch::{Arch, Reader, U8Reader}; +//! //! fn show_field_descriptions(decoder: A::Decoder, buf: &[u8]) //! where //! A::Decoder: AnnotatingDecoder, @@ -32,7 +37,7 @@ //! //! println!("decoded instruction {}", inst); //! for (start, end, desc) in sink.records.iter() { -//! println(" bits [{}, {}]: {}", start, end, desc); +//! println!(" bits [{}, {}]: {}", start, end, desc); //! } //! } //! ``` diff --git a/src/color.rs b/src/color.rs index c35f482..d50ec8b 100644 --- a/src/color.rs +++ b/src/color.rs @@ -136,12 +136,10 @@ mod termion_color { use crossterm::style; - use serde::Serialize; - use crate::color::{Colored, YaxColors}; #[cfg(feature="use-serde")] - impl Serialize for ColorSettings { + impl serde::Serialize for ColorSettings { fn serialize(&self, serializer: S) -> Result { use serde::ser::SerializeStruct; let s = serializer.serialize_struct("ColorSettings", 0)?; diff --git a/src/reader.rs b/src/reader.rs index c853a77..028d835 100644 --- a/src/reader.rs +++ b/src/reader.rs @@ -1,4 +1,4 @@ -use crate::StandardDecodeError; +use crate::{StandardDecodeError, StandardPartialDecoderError}; impl From for StandardDecodeError { fn from(_: ReadError) -> StandardDecodeError { -- cgit v1.1