Struct PluginError 

pub struct PluginError {
    pub message: String,
    pub source_file: Option<String>,
    pub line_number: Option<u32>,
    pub severity: PluginErrorSeverity,
}

Error generated by a plugin.

Use PluginError::error or PluginError::warning to create errors, and optionally chain PluginError::at to set the source location.

Example

use rustledger_plugin_types::{PluginError, PluginErrorSeverity};

let error = PluginError::error("Invalid transaction")
    .at("ledger.beancount", 42);

let warning = PluginError::warning("Duplicate entry detected");

Fields

message: String

Error message.

source_file: Option<String>

Source file (if known).

line_number: Option<u32>

Line number (if known).

severity: PluginErrorSeverity

Error severity.

Implementations

impl PluginError

pub fn error(message: impl Into<String>) -> PluginError

Create a new error.

pub fn warning(message: impl Into<String>) -> PluginError

Create a new warning.

pub fn at(self, file: impl Into<String>, line: u32) -> PluginError

Set the source location.

Trait Implementations

impl Clone for PluginError

fn clone(&self) -> PluginError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginError

fn deserialize<__D>( __deserializer: __D, ) -> Result<PluginError, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginError

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.