pub struct SourceContext<T> { /* private fields */ }
Expand description

A structure allowing fast line/column <-> byte offset remapping.

The primary use-case is to allow efficient conversion between SourcePositions (line/column) to byte offsets. The SourcePositions are 0-based. All offsets are treated as u32, and creating a SourceContext for a source that exceeds the range of a u32 will result in an Err.

Examples

use js_source_scopes::{SourceContext, SourcePosition};

let src = r#"const arrowFnExpr = (a) => a;
function namedFnDecl() {}"#;

let ctx = SourceContext::new(src).unwrap();

let offset = ctx.position_to_offset(SourcePosition::new(0, 6)).unwrap() as usize;
assert_eq!(&src[offset..offset+11], "arrowFnExpr");
let offset = ctx.position_to_offset(SourcePosition::new(1, 9)).unwrap() as usize;
assert_eq!(&src[offset..offset+11], "namedFnDecl");

Implementations§

source§

impl<T: AsRef<str>> SourceContext<T>

source

pub fn into_inner(self) -> T

Unwrap this Source Context into the inner source buffer.

source

pub fn new(src: T) -> Result<Self, SourceContextError>

Construct a new Source Context from the given src buffer.

source

pub fn offset_to_position(&self, offset: u32) -> Option<SourcePosition>

Converts a byte offset into the source to the corresponding line/column.

The column is given in UTF-16 code points.

source

pub fn position_to_offset(&self, position: SourcePosition) -> Option<u32>

Converts the given line/column to the corresponding byte offset inside the source.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for SourceContext<T>where T: RefUnwindSafe,

§

impl<T> Send for SourceContext<T>where T: Send,

§

impl<T> Sync for SourceContext<T>where T: Sync,

§

impl<T> Unpin for SourceContext<T>where T: Unpin,

§

impl<T> UnwindSafe for SourceContext<T>where T: UnwindSafe,

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,