Skip to main content

Notification

Struct Notification 

Source
pub struct Notification { /* private fields */ }
Expand description

One query notification (ADR-0363 decision 1): the record { kind, description, remedy, operator_id }.

The kind supplies the metadata — code, GQLSTATUS, severity, category, title and the canonical remedy — so the record stores no copy of it and the two cannot drift. description carries the instance detail (the unknown name, the index text, the procedure name); an instance-specific remedy overrides the kind’s canonical text where the detector can name the precise action (the exact CREATE INDEX, the deprecated_by replacement). operator_id is the raising operator’s PlanNode.id, present only on operator-scoped kinds.

Implementations§

Source§

impl Notification

Source

pub fn new(kind: NotificationKind, description: impl Into<String>) -> Self

One notification of kind with its instance description; no instance remedy (the kind’s canonical remedy applies) and no operator association (statement-scoped until Self::with_operator_id).

Source

pub fn with_operator_id(self, operator_id: usize) -> Self

Attach an operator association — the raising PlanNode.id — the one way an operator-scoped notification gains operator_id.

Source

pub fn with_remedy(self, remedy: impl Into<String>) -> Self

Override the kind’s canonical remedy with the instance-specific action (the exact runnable statement, the replacement name).

Source

pub fn kind(&self) -> NotificationKind

The notification’s kind — the vocabulary row identity.

Source

pub fn description(&self) -> &str

The instance detail — the unknown name, index text, procedure name or warning message.

Source

pub fn code(&self) -> &'static str

The kind’s diagnostic code.

Source

pub fn gql_status(&self) -> &'static str

The kind’s GQLSTATUS value.

Source

pub fn title(&self) -> &'static str

The kind’s canonical title.

Source

pub fn severity(&self) -> NotificationSeverity

The kind’s severity.

Source

pub fn category(&self) -> NotificationCategory

The kind’s category.

Source

pub fn remedy(&self) -> &str

The effective remedy: the instance-specific one when the detector supplied it, else the kind’s canonical remedy. Every vocabulary kind carries a remedy, so this is never absent.

Source

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

The raising operator’s PlanNode.id, on operator-scoped kinds only.

Trait Implementations§

Source§

impl Clone for Notification

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Notification

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Notification

Source§

impl PartialEq for Notification

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Notification

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.