Struct DebugState 

pub struct DebugState { /* private fields */ }

The #[cube] call stack during kernel expansion.

A function without debug data, such as a hand-written expand function, opens no frame. Its ops get the location of the call to it.

Implementations

impl DebugState

pub fn new(enabled: bool) -> Self

An empty call stack that records locations only when enabled.

pub fn is_enabled(&self) -> bool

Whether expansion records locations.

pub fn enter_fn( &mut self, name: &'static str, file: Source, line: u32, column: u32, )

Opens the frame of function name, defined at line and column of file.

pub fn exit_fn(&mut self)

Closes the innermost frame.

pub fn set_pos(&mut self, line: u32, column: u32)

Moves the innermost frame to line and column.

pub fn add_source(&mut self, path: &str, text: &'static str)

Records the file path, and text as its source text. An empty text records only the path.

pub fn sources(&self) -> &BTreeMap<String, &'static str>

The source text of each file, by the path of its Source. It stays after finish, for the compiler.

pub fn files(&self) -> &BTreeSet<String>

The path of each file, with or without its source text. It stays after finish, for the compiler.

pub fn finish(&mut self)

Stops recording, at the end of kernel expansion. Ops that compiler passes insert later get the location of the op they replace.

Trait Implementations

impl Debug for DebugState

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

Formats the value using the given formatter.

impl Default for DebugState

fn default() -> Self

Returns the “default value” for a type.