Struct pgrx_pg_sys::submodules::panic::ErrorReport

pub struct ErrorReport { /* private fields */ }

Represents the set of information necessary for pgrx to promote a Rust panic!() to a Postgres ERROR (or any PgLogLevel level)

Implementations

impl ErrorReport

pub fn new<S: Into<String>>( sqlerrcode: PgSqlErrorCode, message: S, funcname: &'static str ) -> Self

Create a [PgErrorReport] which can be raised via Rust’s std::panic::panic_any() or as a specific Postgres “ereport()` level via [PgErrorReport::report(self, PgLogLevel)]

Embedded “file:line:col” location information is taken from the caller’s location

pub fn set_detail<S: Into<String>>(self, detail: S) -> Self

Set the detail property, whose default is None

pub fn set_hint<S: Into<String>>(self, hint: S) -> Self

Set the hint property, whose default is None

pub fn message(&self) -> &str

Returns the error message of this error report

pub fn detail(&self) -> Option<&str>

Returns the detail message of this error report

pub fn hint(&self) -> Option<&str>

Returns the hint message of this error report

pub fn report(self, level: PgLogLevel)

Report this [PgErrorReport], which will ultimately be reported by Postgres at the specified PgLogLevel

If the provided level is >= PgLogLevel::ERROR this function will not return.

Trait Implementations

impl Debug for ErrorReport

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

Formats the value using the given formatter.

impl Display for ErrorReport

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

Formats the value using the given formatter.