Struct PgDatabaseError

pub struct PgDatabaseError(pub(crate) Notice);

An error returned from the PostgreSQL database.

Tuple Fields

0: Notice

Implementations

impl PgDatabaseError

pub fn severity(&self) -> PgSeverity

pub fn code(&self) -> &str

The SQLSTATE code for this error.

pub fn message(&self) -> &str

The primary human-readable error message. This should be accurate but terse (typically one line).

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

An optional secondary error message carrying more detail about the problem. Might run to multiple lines.

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

An optional suggestion what to do about the problem. This is intended to differ from detail in that it offers advice (potentially inappropriate) rather than hard facts. Might run to multiple lines.

pub fn position(&self) -> Option<PgErrorPosition<'_>>

Indicates an error cursor position as an index into the original query string; or, a position into an internally generated query.

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

An indication of the context in which the error occurred. Presently this includes a call stack traceback of active procedural language functions and internally-generated queries. The trace is one entry per line, most recent first.

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

If this error is with a specific database object, the name of the schema containing that object, if any.

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

If this error is with a specific table, the name of the table.

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

If the error is with a specific table column, the name of the column.

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

If the error is with a specific data type, the name of the data type.

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

If the error is with a specific constraint, the name of the constraint. For this purpose, indexes are constraints, even if they weren’t created with constraint syntax.

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

The file name of the source-code location where this error was reported.

pub fn line(&self) -> Option<usize>

The line number of the source-code location where this error was reported.

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

The name of the source-code routine reporting this error.

Trait Implementations

impl DatabaseError for PgDatabaseError

fn message(&self) -> &str

The primary, human-readable error message.

fn code(&self) -> Option<Cow<'_, str>>

The (SQLSTATE) code for the error.

fn constraint(&self) -> Option<&str>

Returns the name of the constraint that triggered the error, if applicable. If the error was caused by a conflict of a unique index, this will be the index name.

fn table(&self) -> Option<&str>

Returns the name of the table that was affected by the error, if applicable.

fn kind(&self) -> ErrorKind

Returns the kind of the error, if supported.

fn is_unique_violation(&self) -> bool

Returns whether the error kind is a violation of a unique/primary key constraint.

fn is_foreign_key_violation(&self) -> bool

Returns whether the error kind is a violation of a foreign key.

fn is_check_violation(&self) -> bool

Returns whether the error kind is a violation of a check.

impl Debug for PgDatabaseError

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

Formats the value using the given formatter.

impl Display for PgDatabaseError

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

Formats the value using the given formatter.

impl Error for PgDatabaseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.