pub struct ScopeIndex { /* private fields */ }
Expand description

An indexed structure of scopes that allows quick lookup by byte offset.

Construction of the index will validate that the scopes are well nested and parents fully contain their children. A list of scopes that are not well nested will result in an Err on construction.

Examples

use js_source_scopes::{ScopeIndex, ScopeLookupResult};

let scopes = vec![
    (5..25, Some(String::from("parent"))),
    (10..15, Some(String::from("child"))),
    (20..25, Some(String::from("child2"))),
    (30..50, None),
];

let idx = ScopeIndex::new(scopes).unwrap();
assert_eq!(idx.lookup(3), ScopeLookupResult::Unknown);
assert_eq!(idx.lookup(12), ScopeLookupResult::NamedScope("child"));
assert_eq!(idx.lookup(40), ScopeLookupResult::AnonymousScope);

Implementations§

source§

impl ScopeIndex

source

pub fn new( scopes: Vec<(Range<u32>, Option<String>)> ) -> Result<Self, ScopeIndexError>

Creates a new Scope index from the given list of Scopes.

source

pub fn lookup(&self, offset: u32) -> ScopeLookupResult<'_>

Looks up the scope corresponding to the given offset.

source

pub fn iter(&self) -> impl Iterator<Item = (u32, ScopeLookupResult<'_>)>

Returns an iterator over the scopes in this index and their starting offsets.

Scopes are returned in order of their starting offsets.

Trait Implementations§

source§

impl Debug for ScopeIndex

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> Send for Twhere T: ?Sized,

source§

impl<T> Sync for Twhere T: ?Sized,