Struct SplitedCode

pub struct SplitedCode { /* private fields */ }

A code that has been split into lines and characters for processing

Example

use trees_lang::compile::{SplitedCode, split_code, CharWidthMode, CompileConfig, CodeCharacter};

// Split each character
let mut splited_code: SplitedCode = split_code(
  &vec![" ┌─".to_owned()],
  &CompileConfig {
    char_width: CharWidthMode::Mono
  }
);

// Get each characters' position
// (It is useful if char_width is not Mono)
assert_eq!(splited_code.enumurate_x(0).collect::<Vec<_>>(), vec![0, 1, 2]);

// Get char of target position
assert_eq!(splited_code.get(1, 0), Some(CodeCharacter {
  char: "┌".to_owned(), x: 1, len: 1
}));

Implementations

impl SplitedCode

pub fn get(&self, x: usize, y: usize) -> Option<CodeCharacter>

Retrieves a specific character at position (x, y) from the split code.

If the position is out of bounds or does not contain a character, returns None.

pub fn get_slice_of_line( &self, x_min_exclusive: usize, x_max_exclusive: usize, y: usize, ) -> Option<String>

Retrieves a slice of characters from the specified line between x_min_exclusive and x_max_exclusive.

If the range is invalid or out of bounds, returns None.

pub fn left_x(&self, x: usize, y: usize) -> Option<usize>

Retrieves the position of the character to the left of the given (x, y) position.

If there is no character to the left, returns None.

pub fn right_x(&self, x: usize, y: usize) -> Option<usize>

Retrieves the position of the character to the right of the given (x, y) position.

If there is no character to the right, returns None.

pub fn len_y(&self) -> usize

Returns the number of lines in the SplitedCode.

pub fn enumurate_x(&self, y: usize) -> Box<dyn Iterator<Item = usize> + '_>

Enumerates the x-positions of all characters in the given line y.\

Trait Implementations

impl Clone for SplitedCode

fn clone(&self) -> SplitedCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SplitedCode

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

Formats the value using the given formatter.

impl PartialEq for SplitedCode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SplitedCode

impl StructuralPartialEq for SplitedCode