Struct Locations

pub struct Locations { /* private fields */ }

Location lookup table from bytecode address to original AST location.

When a project is compiled via ByteCode::compile, a stream of instructions is produced. However, this conversion loses the information that would be needed to produce human-readable error locations. This object acts as a map from bytecode location to original AST location in the source project.

This type supports serde serialization if the serde feature flag is enabled.

Implementations

impl Locations

pub fn lookup(&self, bytecode_pos: usize) -> Option<CompactString>

Looks up a bytecode position and returns the most local block location provided by the ast. If the ast came from a standard NetsBlox XML file, this is the collab id of the looked up bytecode address. In other cases, this could be some other localization mechanism for error reporting (e.g., line number and column).

Note that it is possible for blocks to not have location information, hence returning the most local location that was provided in the ast.

Trait Implementations

impl Debug for Locations

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Locations

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Locations

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.