Struct tweep::Warning

pub struct Warning {
    pub kind: WarningKind,
    pub context: Option<Context>,
    pub referent: Option<Context>,
}

A warning with a WarningKind, Position, and optionally a reference to another Position

Examples

use tweep::{FullContext, Warning, WarningKind};
let warning = Warning::new(WarningKind::DuplicateStoryTitle, Some(context))
    .with_referent(referent);

Fields

kind: WarningKind

The warning type

context: Option<Context>

The context of this Warning

referent: Option<Context>

The location referenced by this warning

Implementations

impl Warning

pub fn new<T: Into<Context>>(kind: WarningKind, context: Option<T>) -> Self

Creates a new Warning with a default Position and no referent

Examples

use tweep::{FullContext, Warning, WarningKind};
let warning = Warning::new(WarningKind::MissingStartPassage, Some(context));

pub fn has_referent(&self) -> bool

Returns true if this Warning has a referent

Examples

use tweep::{FullContext, Warning, WarningKind};
let mut warning = Warning::new(WarningKind::UnclosedLink, Some(context));
assert!(!warning.has_referent());
warning.set_referent(referent);
assert!(warning.has_referent());

pub fn get_referent(&self) -> Option<&Context>

Gets the referent if one exists

Examples

let warning = Warning::new(WarningKind::DuplicateStoryTitle, Some(context))
    .with_referent(referent.clone());
assert_eq!(warning.get_referent(), Some(&referent));

pub fn set_referent<T: Into<Context>>(&mut self, referent: T)

Sets the referent to the given Position

Examples

let mut warning = Warning::new(WarningKind::DuplicateStoryTitle, Some(context));
warning.set_referent(referent.clone());
assert_eq!(warning.get_referent(), Some(&referent));

pub fn with_referent<T: Into<Context>>(self, referent: T) -> Self

Moves the object, sets the referent to the given Position, and returns the modified object

Examples

let warning = Warning::new(WarningKind::DuplicateStoryTitle, Some(context))
    .with_referent(referent.clone());
assert_eq!(warning.get_referent(), Some(&referent));

Trait Implementations

impl Clone for Warning

fn clone(&self) -> Warning

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Warning

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

Formats the value using the given formatter.

impl Display for Warning

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

Formats the value using the given formatter.

impl Eq for Warning

impl PartialEq<Warning> for Warning

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Warning

impl StructuralPartialEq for Warning