Struct Position

#[repr(C)]
pub struct Position {
    pub file_id: FileId,
    pub offset: usize,
}

Represents a specific byte offset within a single source file.

This struct combines a FileId with a zero-based offset to create a precise, unique location pointer.

The memory layout is specified as #[repr(C)] to ensure stability for potential foreign function interfaces (FFI).

Fields

file_id: FileId

The unique identifier of the file this position belongs to.

offset: usize

The zero-based byte offset from the beginning of the file.

Implementations

impl Position

pub fn new(file_id: FileId, offset: usize) -> Self

Creates a new Position from a file ID and a byte offset.

pub fn dummy(offset: usize) -> Self

Creates a “dummy” position with a null file ID.

This is useful for generated code or locations that don’t map to a real file.

pub fn start_of(file_id: FileId) -> Self

Creates a position at the very beginning of a file.

pub const fn forward(&self, offset: usize) -> Self

Returns a new position moved forward by the given offset.

Uses saturating arithmetic to prevent overflow.

pub fn backward(&self, offset: usize) -> Self

Returns a new position moved backward by the given offset.

Uses saturating arithmetic to prevent underflow.

pub fn range_for(&self, length: usize) -> Range<usize>

Creates a Range<usize> starting at this position’s offset with a given length.

Trait Implementations

impl Add<usize> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Self::Output

Performs the + operation.

impl AddAssign<usize> for Position

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Position

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Position

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

Formats the value using the given formatter.

impl From<&Position> for usize

fn from(position: &Position) -> usize

Converts to this type from the input type.

impl From<Position> for usize

fn from(position: Position) -> usize

Converts to this type from the input type.

impl HasFileId for Position

fn file_id(&self) -> FileId

Returns the unique identifier of the file.

impl HasPosition for Position

fn position(&self) -> Position

Returns the source position.

fn offset(&self) -> usize

A convenience method to get the byte offset of the position.

impl Hash for Position

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 Position

fn cmp(&self, other: &Position) -> 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 Position

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Position

fn partial_cmp(&self, other: &Position) -> 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 Serialize for Position

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<usize> for Position

type Output = Position

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Self::Output

Performs the - operation.

impl SubAssign<usize> for Position

fn sub_assign(&mut self, rhs: usize)

Moves the position backward in-place.

impl Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position