Module source 

Utils for extracting, inspecting or transforming source code

Re-exports

use std::sync::Arc; 🔒

use rustc_ast::LitKind; 🔒

use rustc_ast::StrStyle; 🔒

use rustc_errors::Applicability; 🔒

use rustc_hir::BlockCheckMode; 🔒

use rustc_hir::Expr; 🔒

use rustc_hir::ExprKind; 🔒

use rustc_hir::UnsafeSource; 🔒

use rustc_lexer::FrontmatterAllowed; 🔒

use rustc_lexer::LiteralKind; 🔒

use rustc_lexer::TokenKind; 🔒

use rustc_lexer::tokenize; 🔒

use rustc_lint::EarlyContext; 🔒

use rustc_lint::LateContext; 🔒

use rustc_middle::ty::TyCtxt; 🔒

use rustc_session::Session; 🔒

use rustc_span::source_map::SourceMap; 🔒

use rustc_span::source_map::original_sp; 🔒

use rustc_span::BytePos; 🔒

use rustc_span::DUMMY_SP; 🔒

use rustc_span::DesugaringKind; 🔒

use rustc_span::Pos as _; 🔒

use rustc_span::RelativeBytePos; 🔒

use rustc_span::SourceFile; 🔒

use rustc_span::SourceFileAndLine; 🔒

use rustc_span::Span; 🔒

use rustc_span::SpanData; 🔒

use rustc_span::SyntaxContext; 🔒

use rustc_span::hygiene; 🔒

use std::borrow::Cow; 🔒

use std::fmt; 🔒

use std::ops::Deref; 🔒

use std::ops::Index; 🔒

use std::ops::Range; 🔒

Structs

SourceFileRange

A range within a specific source file.

SourceText

Handle to a range of text in a source file.

Traits

HasSourceMap

Types from which a SourceMap can be obtained.

IntoSpan

Conversion of a value into a Span

SpanExt

Extension methods for span-like types (anything implementing SpanRange) that need access to the underlying source text via a HasSourceMap.

SpanRange

Conversion of a value into the range portion of a Span.

Functions

ends_with_line_comment_or_broken 🔒

expand_past_previous_comma

Expand a span to include a preceding comma

expr_block

Like snippet_block, but add braces if the expr is not an ExprKind::Block with no label.

first_char_in_first_line 🔒

first_line_of_span

Returns a new Span that extends the original Span to the first non-whitespace char of the first line.

get_source_range 🔒

indent_of

Returns the indentation of the line of a span

is_present_in_source

Checks whether the code snippet referred to by the given [Span] is present in the source code.

line_span 🔒

Extends the span to the beginning of the spans line, incl. whitespaces.

map_range 🔒

position_before_rarrow

Returns the position just before rarrow

reindent_multiline

Reindent a multiline string with possibility of ignoring the first line.

reindent_multiline_inner 🔒

snippet

Converts a span to a code snippet if available, otherwise returns the default.

snippet_block

Converts a span (from a block) to a code snippet if available, otherwise use default.

snippet_block_with_applicability

Same as snippet_block, but adapts the applicability level by the rules of snippet_with_applicability.

snippet_block_with_context

Combination of snippet_block and snippet_with_context.

snippet_indent

Gets a snippet of the indentation of the line of a span

snippet_opt

Converts a span to a code snippet. Returns None if not available.

snippet_with_applicability

Same as snippet, but it adapts the applicability level by following rules:

snippet_with_applicability_sm 🔒

snippet_with_context

Same as snippet_with_applicability, but first walks the span up to the given context.

snippet_with_context_sm 🔒

str_literal_to_char_literal

Converts expr to a char literal if it’s a str literal containing a single character (or a single byte with ascii_only)

trim_span

Trims the whitespace from the start and the end of the span.

trim_start 🔒

walk_span_to_context

Walks the span up to the target context, thereby returning the macro call site if the span is inside a macro expansion, or the original span if it is not.

with_leading_whitespace 🔒

with_leading_whitespace_inner 🔒

with_source_text 🔒

with_source_text_and_range 🔒