status.rs

// Certain casts are required only on Windows. Inform Clippy to ignore them.
#![allow(clippy::unnecessary_cast)]

use crate::error::{PtError, PtErrorCode};
use bitflags::bitflags;
use libipt_sys::{
    pt_status_flag_pts_eos, pt_status_flag_pts_event_pending, pt_status_flag_pts_ip_suppressed,
};

bitflags! {
    /// Status flags for various IntelPT actions
    #[derive(Debug, Clone, Copy)]
    pub struct Status: u32 {
        /// There is no more trace data available.
        const EOS = pt_status_flag_pts_eos as u32;
        /// There is an event pending.
        const EVENT_PENDING = pt_status_flag_pts_event_pending as u32;
        /// The address has been suppressed.
        const IP_SUPRESSED  = pt_status_flag_pts_ip_suppressed as u32;
    }
}

impl Status {
    pub(crate) fn from_bits_or_pterror(pt_status: u32) -> Result<Self, PtError> {
        Status::from_bits(pt_status).ok_or(PtError::new(
            PtErrorCode::Internal,
            "Unknown state returned by libipt, failed to convert to Status",
        ))
    }

    /// There is no more trace data available.
    #[must_use]
    pub const fn eos(&self) -> bool {
        self.contains(Status::EOS)
    }

    /// There is an event pending.
    #[must_use]
    pub const fn event_pending(&self) -> bool {
        self.contains(Status::EVENT_PENDING)
    }

    /// The address has been suppressed.
    #[must_use]
    pub const fn ip_supressed(&self) -> bool {
        self.contains(Status::IP_SUPRESSED)
    }
}