Struct calyx_utils::GPosIdx

pub struct GPosIdx(pub PosIdx);

A position index backed by a global PositionTable

Tuple Fields

0: PosIdx

Implementations

impl GPosIdx

pub const UNKNOWN: GPosIdx = _

Symbol for the unknown position

pub fn into_option(self) -> Option<Self>

Convert the position into an optional. Returns None if the position is the unknown position.

pub fn get_line_num(&self) -> (&String, (usize, usize))

returns:

1. the name of the file the span is in
2. the (inclusive) range of lines within the span

pub fn format_raw<S: AsRef<str>>(&self, err_msg: S) -> String

Format this position with the error message err_msg

pub fn format<S: AsRef<str>>(&self, err_msg: S) -> String

Format this position with filename header and the error message err_msg

pub fn get_location(&self) -> (&str, usize, usize)

pub fn show(&self) -> String

Visualizes the span without any message or marking

Trait Implementations

impl Clone for GPosIdx

fn clone(&self) -> GPosIdx

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GPosIdx

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

Formats the value using the given formatter.

impl Default for GPosIdx

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<GPosIdx> for GPosIdx

fn eq(&self, other: &GPosIdx) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WithPos for GPosIdx

fn copy_span(&self) -> GPosIdx

Copy the span associated with this node.

impl Copy for GPosIdx

impl Eq for GPosIdx

impl StructuralEq for GPosIdx

impl StructuralPartialEq for GPosIdx