Struct ExceptionInfo

pub struct ExceptionInfo<'a>(/* private fields */);

Information about an exception.

Implementations

impl ExceptionInfo<'_>

pub unsafe fn new<'a>( signo: c_int, siginfo: *mut siginfo_t, context: *mut c_void, ) -> ExceptionInfo<'a>

Construct from arguments passed to a POSIX signal handler.

Safety

The caller must ensure the validity of the pointers and limit the lifetime of the ExceptionInfo structure to that of the pointers. On platforms which have a ucontext_t type, context must point to one or else be NULL.

pub fn into_owned(self) -> ExceptionInfo<'static>

Converts self into a representation which owns its storage.

pub fn signo_raw(&self) -> c_int

Returns the raw signal number which was passed to the signal handler.

pub fn signinfo_raw(&self) -> &siginfo_t

Returns a reference to the raw siginfo_t structure which was passed to the signal handler.

pub fn context(&self) -> *mut c_void

Returns the context pointer which was passed to the signal handler.

pub fn signo(&self) -> Signo

Returns the type of signal which triggered this exception.

pub fn addr(&self) -> *mut c_void

Returns the address of the memory access which triggered the exception.

pub fn signal(&self) -> Result<Signal, UnsupportedSignalError>

Returns the type of signal which triggered this exception along with its associated subtype.

This method is guaranteed to succeed when called on an ExceptionInfo which was passed to a registered hook by a signal handler which was installed by this crate.

pub fn addr_lsb(&self) -> Option<c_short>

For SIGBUS signals of subtype MCEERR_AO or MCEERR_AR, this returns an indication the least significant bit of the reported address and therefore the extent of the corruption. For example, if a full page is corrupted, this returns log2(sysconf(_SC_PAGESIZE)).

For all other signals and subtypes, this returns None.

pub fn lower(&self) -> Option<*mut c_void>

For SIGSEGV signals of subtype BNDERR, this returns the lower bound of the failed bounds check. Otherwise it returns None.

pub fn upper(&self) -> Option<*mut c_void>

For SIGSEGV signals of subtype BNDERR, this returns the upper bound of the failed bounds check. Otherwise it returns None.

pub fn pkey(&self) -> Option<c_int>

For SIGSEGV signals of subtype PKUERR, this returns the protection key on the page table entry (PTE) which caused the exception.

pub fn sp(&self) -> *mut c_void

Returns the contents of the stack pointer register at the time of the exception.

Not supported on all platforms. If unsupported, returns null. Adding support for new platforms is usually straightforward; please file an issue if you want something added.

pub fn ip(&self) -> *mut c_void

Returns the address of the instruction which triggered the exception.

Not supported on all platforms. If unsupported, returns null. Adding support for new platforms is usually straightforward; please file an issue if you want something added.

pub fn symbol_address(&self) -> *mut c_void

Returns the starting symbol address of the function which triggered the exception.

Not supported on all platforms. If unsupported, returns null. Adding support for new platforms is usually straightforward; please file an issue if you want something added.

Trait Implementations

impl<'a> Clone for ExceptionInfo<'a>

fn clone(&self) -> ExceptionInfo<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ExceptionInfo<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ExceptionInfo<'_>> for ExtExceptionInfo

fn from(info: ExceptionInfo<'_>) -> Self

Converts to this type from the input type.