Struct CodeView

pub struct CodeView<T> { /* private fields */ }

Save the given code and store additional information on each character

Examples

use code_span::CodeView;
let _: CodeView<&'static str> = CodeView::from("public static class MyClass {}");

Implementations

impl<T> CodeView<T>

pub fn blank(text: impl Into<String>) -> Self

where T: Clone,

Create a piece of code with no information

Examples

use code_span::CodeView;
let _: CodeView<&'static str> = CodeView::blank("public static class MyClass {}");

pub fn new(text: String, info: Vec<Option<T>>) -> Self

Create a piece of code with specified information

Examples

use code_span::CodeView;
let _: CodeView<&'static str> = CodeView::new("public".to_string(), vec![Some("keyword"); 6]);

pub fn get_text(&self) -> &str

Get original code

Examples

use code_span::CodeView;
let view: CodeView<&'static str> = CodeView::blank("public static class MyClass {}");
assert_eq!(view.get_text(), "public static class MyClass {}");

pub fn mut_text(&mut self) -> &mut String

Modify the original code

Examples

use code_span::CodeView;
let mut view: CodeView<&'static str> = CodeView::blank("public static class MyClass {}");
assert_eq!(view.mut_text(), "public static class MyClass {}");

pub fn get_info(&self) -> &[Option<T>]

Get current information

Examples

use code_span::CodeView;
let view: CodeView<&'static str> = CodeView::blank("public static class MyClass {}");
assert_eq!(view.get_info(), vec![None; 30]);

pub fn mut_info(&mut self) -> &mut [Option<T>]

Modify current information

Examples

use code_span::CodeView;
let mut view: CodeView<&'static str> = CodeView::blank("public");
view.mut_info().iter_mut().for_each(|v| *v = Some("keyword"));

pub fn mark_position(&mut self, start: usize, end: usize, info: Option<T>)

where T: Clone,

Mark the information of a piece of code according to the character range

Examples

use code_span::CodeView;
let mut view = CodeView::blank("public static class MyClass {}");
view.mark_position(0, 6, Some("keyword"));

pub fn mark_offset(&mut self, start: usize, end: usize, info: Option<T>)

where T: Clone,

Mark the information of a piece of code according to the byte range

Examples

use code_span::CodeView;
let mut view = CodeView::blank("public static class MyClass {}");
view.mark_offset(0, 6, Some("keyword"));

Trait Implementations

impl<T: Clone> Clone for CodeView<T>

fn clone(&self) -> CodeView<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CodeView<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CodeView<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> From<&str> for CodeView<T>

where T: Clone,

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<T> From<String> for CodeView<T>

where T: Clone,

fn from(s: String) -> Self

Converts to this type from the input type.

impl<'i, T> IntoIterator for &'i CodeView<T>

where T: Clone + PartialEq,

type Item = CodeSpan<T>

The type of the elements being iterated over.

type IntoIter = CodeViewIter<'i, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for CodeView<T>

fn eq(&self, other: &CodeView<T>) -> 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<T> Serialize for CodeView<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for CodeView<T>

impl<T> StructuralPartialEq for CodeView<T>