Struct json_peek::util::Span

pub struct Span {
    pub start: usize,
    pub end: usize,
}

General position information of string

let a = Span::new(1, 5);
let b = Span::from(1..=5);

assert_eq!(a, b);

let span = Span::new(2, 4);
span.trim(1); // Equal to: Span::new(3, 3);

Fields

start: usize

end: usize

Methods

impl Span

pub const fn new(start: usize, end: usize) -> Span

pub const fn range(&self) -> RangeInclusive<usize>

Get the range of this Span

pub const fn start_point(&self) -> Span

Create a point out of the start position of this Span

pub const fn end_point(&self) -> Span

Create a point out of the end position of this Span

pub const fn is_point(&self) -> bool

Zero-width Span is considered to be a point

pub const fn trim(&self, offset: usize) -> Span

Shrink the size of Span by some offset from both size

Does not check for overflow

let span = Span::new(2, 4);

assert_eq!(span.trim(1), Span::new(3, 3));
assert_eq!(span.trim(2), Span::new(4, 2));

You can cause integer underflow/overflow with this method if not careful.

let span = Span::new(0, 4);
span.trim(5); // <- will panic!!

pub fn from_span(left: Span, right: Span) -> Span

Create Span from two other Spans This function will construct the biggest possible Span

let a = Span::new(1, 5);
let b = Span::new(4, 10);
 
assert_eq!(Span::from_span(a, b), Span::new(1, 10));

pub const fn test() -> Span

Span value for testing purpose

Trait Implementations

impl Add<Span> for Span

type Output = Span

The resulting type after applying the + operator.

fn add(self, rhs: Span) -> Span

Performs the + operation.

impl Add<usize> for Span

type Output = Span

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Span

Performs the + operation.

impl AddAssign<Span> for Span

fn add_assign(&mut self, rhs: Span)

Performs the += operation.

impl AddAssign<usize> for Span

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Span

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Span

Returns the "default value" for a type.

impl Display for Span

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

Formats the value using the given formatter.

impl Eq for Span

impl From<RangeInclusive<usize>> for Span

fn from(range: RangeInclusive<usize>) -> Span

Performs the conversion.

impl Hash for Span

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Span> for Span

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

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

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

This method tests for !=.

impl StructuralEq for Span

impl StructuralPartialEq for Span

impl Sub<Span> for Span

type Output = Span

The resulting type after applying the - operator.

fn sub(self, rhs: Span) -> Span

Performs the - operation.

impl Sub<usize> for Span

type Output = Span

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Span

Performs the - operation.

impl SubAssign<usize> for Span

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.