Struct Notice 

pub struct Notice { /* private fields */ }

Available on crate feature document only.

A one-line message with a level label, such as warning, and an optional code.

The renderer draws the label, then the code if there is one, then the message, separated by ·.

use ctl_core::document::{Notice, NoticeLevel};

let notice = Notice::new(NoticeLevel::Error, "no such row").code("not-found");
assert_eq!(notice.code_value(), Some("not-found"));

Implementations

impl Notice

pub fn new(level: NoticeLevel, message: impl Into<Text>) -> Self

Build a notice of level with no code.

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

Attach a short code that stays the same for the same kind of notice, so a reader can search for it.

pub const fn level(&self) -> NoticeLevel

The severity, which picks the label and its style.

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

The code set by Self::code, if any.

pub const fn message(&self) -> &Text

The message text.

Trait Implementations

impl Clone for Notice

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Notice

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

Formats the value using the given formatter.

impl Eq for Notice

impl From<Notice> for Block

fn from(value: Notice) -> Self

Converts to this type from the input type.

impl PartialEq for Notice

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Notice