Struct Session

pub struct Session {
    pub dcx: DiagCtxt,
    pub opts: Opts,
    /* private fields */
}

Information about the current compiler session.

Fields

dcx: DiagCtxt

The diagnostics context.

opts: Opts

The compiler options.

Implementations

impl Session

pub fn new(dcx: DiagCtxt, source_map: Arc<SourceMap>) -> Self

Creates a new session with the given diagnostics context and source map.

pub fn empty(dcx: DiagCtxt) -> Self

Creates a new session with the given diagnostics context and an empty source map.

pub fn builder() -> SessionBuilder

Creates a new session builder.

pub fn infer_language(&mut self)

Infers the language from the input files.

pub fn validate(&self) -> Result<()>

Validates the session options.

pub fn unstable(&self) -> &UnstableOpts

Returns the unstable options.

pub fn emitted_diagnostics(&self) -> Option<EmittedDiagnostics>

Returns the emitted diagnostics. Can be empty.

Returns None if the underlying emitter is not a human buffer emitter created with with_buffer_emitter.

pub fn emitted_errors(&self) -> Option<Result<(), EmittedDiagnostics>>

Returns Err with the printed diagnostics if any errors have been emitted.

Returns None if the underlying emitter is not a human buffer emitter created with with_buffer_emitter.

pub fn source_map(&self) -> &SourceMap

Returns a reference to the source map.

pub fn clone_source_map(&self) -> Arc<SourceMap>

Clones the source map.

pub fn stop_after(&self, stage: CompilerStage) -> bool

Returns true if compilation should stop after the given stage.

pub fn threads(&self) -> usize

Returns the number of threads to use for parallelism.

pub fn is_sequential(&self) -> bool

Returns true if parallelism is not enabled.

pub fn is_parallel(&self) -> bool

Returns true if parallelism is enabled.

pub fn do_emit(&self, output: CompilerOutput) -> bool

Returns true if the given output should be emitted.

pub fn spawn(&self, f: impl FnOnce() + Send + 'static)

Spawns the given closure on the thread pool or executes it immediately if parallelism is not enabled.

pub fn join<A, B, RA, RB>(&self, oper_a: A, oper_b: B) -> (RA, RB)

where A: FnOnce() -> RA + Send, B: FnOnce() -> RB + Send, RA: Send, RB: Send,

Takes two closures and potentially runs them in parallel. It returns a pair of the results from those closures.

pub fn scope<'scope, OP, R>(&self, op: OP) -> R

where OP: FnOnce(Scope<'_, 'scope>) -> R + Send, R: Send,

Executes the given closure in a fork-join scope.

See rayon::scope for more details.

pub fn enter<R>(&self, f: impl FnOnce() -> R) -> R

Sets up the session globals if they doesn’t exist already and then executes the given closure.

Note that this does not set up the rayon thread pool. This is only useful when parsing sequentially, like manually using Parser.

This also calls SessionGlobals::with_source_map.

pub fn enter_parallel<R: Send>(&self, f: impl FnOnce() -> R + Send) -> R

Sets up the thread pool and session globals if they doesn’t exist already and then executes the given closure.

This also calls SessionGlobals::with_source_map.