Struct tweep::Warning

pub struct Warning {
    pub warning_type: WarningType,
    pub position: Position,
    pub referent: Option<Position>,
}

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

Examples

use tweep::{Position, Warning, WarningType};
let warning = Warning::new(WarningType::DuplicateStoryTitle)
    .with_referent(Position::RowColumn(5, 0));

Fields

warning_type: WarningType

The warning type

position: Position

The location of the warning

referent: Option<Position>

The location referenced by this warning

Methods

impl Warning

pub fn new(warning_type: WarningType) -> Self

Creates a new Warning with a default Position and no referent

Examples

use tweep::{Warning, WarningType};
let warning = Warning::new(WarningType::MissingStartPassage);

pub fn has_referent(&self) -> bool

Returns true if this Warning has a referent

Examples

use tweep::{Position, Warning, WarningType};
let mut warning = Warning::new(WarningType::UnclosedLink);
assert!(!warning.has_referent());
warning.set_referent(Position::RowColumn(23, 5));
assert!(warning.has_referent());

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

Gets the referent if one exists

Examples

use tweep::{Position, Warning, WarningType};
let warning = Warning::new(WarningType::DuplicateStoryTitle)
    .with_referent(Position::RowColumn(5, 0));
assert_eq!(warning.get_referent(), Some(&Position::RowColumn(5, 0)));

pub fn set_referent(&mut self, referent: Position)

Sets the referent to the given Position

Examples

use tweep::{Position, Warning, WarningType};
let mut warning = Warning::new(WarningType::UnclosedLink);
assert!(!warning.has_referent());
warning.set_referent(Position::RowColumn(23, 5));
assert!(warning.has_referent());
assert_eq!(warning.get_referent(), Some(&Position::RowColumn(23, 5)));

pub fn with_referent(self, referent: Position) -> Self

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

Examples

use tweep::{Position, Warning, WarningType};
let warning = Warning::new(WarningType::DuplicateStoryTitle)
    .with_referent(Position::RowColumn(5, 0));

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 Positional for Warning

fn get_position(&self) -> &Position

Get an immutable reference to the associated Position. Unimplemented by default.

fn mut_position(&mut self) -> &mut Position

Get an mutable reference to the associated Position. Unimplemented by default.

fn get_column(&self) -> Option<usize>

Gets the column of the associated Position if it has one

fn set_column(&mut self, col: usize)

Sets the column of the associated Position

fn offset_column(&mut self, offset: usize)

Offsets the column of the associated Position by offset

fn get_row(&self) -> Option<usize>

Gets the row of the associated Position if it has one

fn set_row(&mut self, row: usize)

Sets the row of the associated Position

fn offset_row(&mut self, offset: usize)

Offsets the row of the associated Position by offset

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

Gets the file name of the associated Position if it has one

fn set_file(&mut self, file: String)

Sets the file name of the associated Position

fn with_offset_row(self, offset: usize) -> Self where
    Self: Sized, 

Moves self, calls offset_row with the given offset and returns a new instance with the offset value

fn with_offset_column(self, offset: usize) -> Self where
    Self: Sized, 

Moves self, calls offset_column with the given offset and returns a new instance with the offset value

fn with_column(self, col: usize) -> Self where
    Self: Sized, 

Moves self, calls set_column with the given col value and returns a new instance with the set value

fn with_row(self, row: usize) -> Self where
    Self: Sized, 

Moves self, calls set_row with the given row value and returns a new instance with the set value

fn with_file(self, file: String) -> Self where
    Self: Sized, 

Moves self, calls set_file with the given file value and returns a new instance with the set value

impl StructuralEq for Warning

impl StructuralPartialEq for Warning