Struct FileIndex 

pub struct FileIndex(/* private fields */);

An index into a GSYM file table.

Index ZERO is reserved for the empty file entry, so real files are numbered from 1. A line row that carries index zero has no known source file rather than a file named "".

Implementations

impl FileIndex

pub const ZERO: Self

Reserved index representing the empty file entry.

pub const fn new(index: u32) -> Self

Wraps a raw file-table index.

pub const fn get(self) -> u32

Returns the raw file-table index.

Trait Implementations

impl Clone for FileIndex

fn clone(&self) -> FileIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FileIndex

impl Debug for FileIndex

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

Formats the value using the given formatter.

impl Default for FileIndex

fn default() -> FileIndex

Returns the “default value” for a type.

impl Eq for FileIndex

impl From<FileIndex> for u32

fn from(index: FileIndex) -> Self

Converts to this type from the input type.

impl From<FileIndex> for u64

fn from(index: FileIndex) -> Self

Converts to this type from the input type.

impl From<u32> for FileIndex

fn from(index: u32) -> Self

Converts to this type from the input type.

impl Hash for FileIndex

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileIndex

fn cmp(&self, other: &FileIndex) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FileIndex

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FileIndex

fn partial_cmp(&self, other: &FileIndex) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FileIndex