Enum tweep::Position

pub enum Position {
    Column(usize),
    RowColumn(usize, usize),
    File(String, usize, usize),
    StoryLevel,
}

A position within the content of a Twee story.

By default, a Position is a global StoryLevel. Additional context can be added from there to create a position at File, row, and column level.

Notes

When setting an individual field of a Position, if the current enum variant does not support that field, the value will automatically be promoted to the most general variant that does support that field and default values will be used for any remaining, unset fields. For instance, if set_column is called on a StoryLevel variant, it will be promoted to a Column variant with the given column value. However, if set_file is called on a Column variant, it will be promoted to a File variant, which will contain the newly set filename, the existing column value, and a default row value of 1.

Variants

Column(usize)

A column location, contains the column number

RowColumn(usize, usize)

A row and column location, contains the row number then column number

File(String, usize, usize)

A file location, contains the file name, row, and column

StoryLevel

Default, global level

Methods

impl Position

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

Gets the column of this Position if one exists.

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos.get_column(), None);
pos.set_column(5);
assert_eq!(pos.get_column(), Some(5));

pub fn set_column(&mut self, col: usize)

Sets the column of this Position. If the current value does not accomodate a column, the enum will be promoted to a value that does.

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos, Position::StoryLevel);
pos.set_column(23);
assert_eq!(pos, Position::Column(23));

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

Gets the file name referenced by this Position, if there is one.

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos.get_file(), None);
let file_name = "file.ext";
pos.set_file(file_name.to_string());
assert_eq!(pos.get_file(), Some(file_name));

pub fn set_file(&mut self, file: String)

Sets the file name of this Position. If the current value does not accomodate a file name, the enum will be promoted to a value that does. In such a case, the row and column will be set to a default of 1 if they are not already set

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos, Position::StoryLevel);
let file_name = "file.ext";
pos.set_file(file_name.to_string());
assert_eq!(pos, Position::File(file_name.to_string(), 1, 1));

pub fn offset_column(&mut self, offset: usize)

Offsets the column of this Position by offset. If it's not currently storing a column, this has the same effect as set_column(offset)

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos.get_column(), None);
pos.offset_column(4);
assert_eq!(pos.get_column(), Some(5));
pos.offset_column(5);
assert_eq!(pos.get_column(), Some(10));

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

Gets the row of this Position if one exists.

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos.get_row(), None);
pos.set_row(5);
assert_eq!(pos.get_row(), Some(5));

pub fn set_row(&mut self, row: usize)

Sets the row of this Position. If the current value does not accomodate a row, the enum will be promoted to a value that does.

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos, Position::StoryLevel);
pos.set_row(23);
assert_eq!(pos, Position::RowColumn(23, 1));

pub fn offset_row(&mut self, offset: usize)

Offsets the row of this Position by offset. If it's not currently storing a row, this has the same effect as set_row(offset)

Examples

use tweep::Position;
let mut pos = Position::default();
assert_eq!(pos.get_row(), None);
pos.offset_row(4);
assert_eq!(pos.get_row(), Some(5));
pos.offset_row(5);
assert_eq!(pos.get_row(), Some(10));

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Self

Returns the "default value" for a type.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl PartialEq<Position> for Position

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

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

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

This method tests for !=.

impl StructuralEq for Position

impl StructuralPartialEq for Position