Struct rune::Source

source · [−]

pub struct Source { /* private fields */ }

Expand description

A single source file.

Implementations

source

impl Source

source

pub fn emit_source_line<O>(&self, out: &mut O, span: Span) -> Result<()> where
O: WriteColor,

Available on crate feature emit only.

Print formatted diagnostics about a source conveniently.

source

impl Source

source

pub fn new(name: impl AsRef<str>, source: impl AsRef<str>) -> Self

Construct a new source with the given name.

source

pub fn from_path(path: &Path) -> Result<Self>

Read and load a source from the given path.

source

pub fn with_path(
 name: impl AsRef<str>,
 source: impl AsRef<str>,
 path: Option<impl AsRef<Path>>
) -> Self

Construct a new source with the given name.

source

pub fn line_starts(&self) -> &[usize ]

Access all line starts in the source.

source

pub fn is_empty(&self) -> bool

Test if the source is empty.

source

pub fn len(&self) -> usize

Get the length of the source.

source

pub fn name(&self) -> &str

Get the name of the source.

source

pub fn get(&self, i: I) -> Option<&I::Output> where
I: SliceIndex<str>,

et the given range from the source.

source

pub fn as_str(&self) -> &str

Access the underlying string for the source.

source

pub fn path(&self) -> Option<&Path>

Get the (optional) path of the source.

source

pub fn position_to_utf16cu_line_char(
&self,
offset: usize
) -> Option<(usize, usize )>

Convert the given offset to a utf-16 line and character.

source

pub fn position_to_unicode_line_char(&self, offset: usize) -> (usize, usize )

Convert the given offset to a utf-16 line and character.

source

pub fn line_index(&self, byte_index: usize) -> usize

Get the line index for the given byte.

source

pub fn line_range(&self, line_index: usize) -> Option<Range<usize>>

Get the range corresponding to the given line index.

source

pub fn line_count(&self) -> usize

Get the number of lines in the source.

source

pub fn line(&self, span: Span) -> Option<(usize, usize, &str )>

Access the line number of content that starts with the given span.

Trait Implementations

source

impl Clone for Source

source

fn clone(&self) -> Source

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Source

source

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

Formats the value using the given formatter. Read more

source

impl Default for Source

source

fn default() -> Source

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Source

impl Send for Source

impl Sync for Source

impl Unpin for Source

impl UnwindSafe for Source

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct rune::Source

Implementations

impl Source

pub fn emit_source_line<O>(&self, out: &mut O, span: Span) -> Result<()> where O: WriteColor,

impl Source

pub fn new(name: impl AsRef<str>, source: impl AsRef<str>) -> Self

pub fn from_path(path: &Path) -> Result<Self>

pub fn with_path( name: impl AsRef<str>, source: impl AsRef<str>, path: Option<impl AsRef<Path>>) -> Self

pub fn line_starts(&self) -> &[usize]

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn name(&self) -> &str

pub fn get<I>(&self, i: I) -> Option<&I::Output> where I: SliceIndex<str>,

pub fn as_str(&self) -> &str

pub fn path(&self) -> Option<&Path>

pub fn position_to_utf16cu_line_char( &self, offset: usize) -> Option<(usize, usize)>

pub fn position_to_unicode_line_char(&self, offset: usize) -> (usize, usize)

pub fn line_index(&self, byte_index: usize) -> usize

pub fn line_range(&self, line_index: usize) -> Option<Range<usize>>

pub fn line_count(&self) -> usize

pub fn line(&self, span: Span) -> Option<(usize, usize, &str)>

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

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

impl Debug for Source

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

impl Default for Source

fn default() -> Source

Auto Trait Implementations

impl RefUnwindSafe for Source

impl Send for Source

impl Sync for Source

impl Unpin for Source

impl UnwindSafe for Source

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn emit_source_line<O>(&self, out: &mut O, span: Span) -> Result<()> where
O: WriteColor,

pub fn with_path(
name: impl AsRef<str>,
source: impl AsRef<str>,
path: Option<impl AsRef<Path>>
) -> Self

pub fn line_starts(&self) -> &[usize ]

pub fn get<I>(&self, i: I) -> Option<&I::Output> where
I: SliceIndex<str>,

pub fn position_to_utf16cu_line_char(
&self,
offset: usize
) -> Option<(usize, usize )>

pub fn position_to_unicode_line_char(&self, offset: usize) -> (usize, usize )

pub fn line(&self, span: Span) -> Option<(usize, usize, &str )>

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

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