Struct clang::source::File

source · [−]

pub struct File<'tu> { /* private fields */ }

Expand description

A source file.

Implementations

source

impl<'tu> File<'tu>

source

pub fn get_path(&self) -> PathBuf

Returns the absolute path to this file.

source

pub fn get_time(&self) -> time_t

Returns the last modification time for this file.

source

pub fn get_id(&self) -> (u64, u64, u64 )

Returns a unique identifier for this file.

source

pub fn get_contents(&self) -> Option<String>

Returns the contents of this file, if this file has been loaded.

source

pub fn get_module(&self) -> Option<Module<'tu>>

Returns the module containing this file, if any.

source

pub fn get_skipped_ranges(&self) -> Vec<SourceRange<'tu>>

Returns the source ranges in this file that were skipped by the preprocessor.

This will always return an empty Vec if the translation unit that contains this file was not constructed with a detailed preprocessing record.

source

pub fn is_include_guarded(&self) -> bool

Returns whether this file is guarded against multiple inclusions.

source

pub fn get_location(&self, line: u32, column: u32) -> SourceLocation<'tu>

Returns the source location at the supplied line and column in this file.

Panics

line or column is 0

source

pub fn get_offset_location(&self, offset: u32) -> SourceLocation<'tu>

Returns the source location at the supplied character offset in this file.

source

pub fn get_includes(&self) -> Vec<Entity<'tu>>

Returns the inclusion directives in this file.

source

pub fn get_references(&self, entity: Entity<'tu>) -> Vec<Entity<'tu>>

Returns the references to the supplied entity in this file.

source

pub fn visit_includes<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>(
&self,
f: F
) -> bool

Visits the inclusion directives in this file and returns whether visitation was ended by the callback returning false.

source

pub fn visit_references<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>(
 &self,
 entity: Entity<'tu>,
 f: F
) -> bool

Visits the references to the supplied entity in this file and returns whether visitation was ended by the callback returning false.

Trait Implementations

source

impl<'tu> Clone for File<'tu>

source

fn clone(&self) -> File<'tu>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'tu> Debug for File<'tu>

source

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

Formats the value using the given formatter. Read more

source

impl<'tu> Hash for File<'tu>

source

fn hash<H: Hasher>(&self, hasher: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl<'tu> PartialEq<File<'tu>> for File<'tu>

source

fn eq(&self, other: &File<'tu>) -> bool

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

1.0.0 · source

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

This method tests for !=.

source

impl<'tu> Copy for File<'tu>

source

impl<'tu> Eq for File<'tu>

Auto Trait Implementations

impl<'tu> RefUnwindSafe for File<'tu>

impl<'tu> !Send for File<'tu>

impl<'tu> !Sync for File<'tu>

impl<'tu> Unpin for File<'tu>

impl<'tu> UnwindSafe for File<'tu>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct clang::source::File

Implementations

impl<'tu> File<'tu>

pub fn get_path(&self) -> PathBuf

pub fn get_time(&self) -> time_t

pub fn get_id(&self) -> (u64, u64, u64)

pub fn get_contents(&self) -> Option<String>

pub fn get_module(&self) -> Option<Module<'tu>>

pub fn get_skipped_ranges(&self) -> Vec<SourceRange<'tu>>

pub fn is_include_guarded(&self) -> bool

pub fn get_location(&self, line: u32, column: u32) -> SourceLocation<'tu>

Panics

pub fn get_offset_location(&self, offset: u32) -> SourceLocation<'tu>

pub fn get_includes(&self) -> Vec<Entity<'tu>>

pub fn get_references(&self, entity: Entity<'tu>) -> Vec<Entity<'tu>>

pub fn visit_includes<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>( &self, f: F) -> bool

pub fn visit_references<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>( &self, entity: Entity<'tu>, f: F) -> bool

Trait Implementations

impl<'tu> Clone for File<'tu>

fn clone(&self) -> File<'tu>

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

impl<'tu> Debug for File<'tu>

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

impl<'tu> Hash for File<'tu>

fn hash<H: Hasher>(&self, hasher: &mut H)

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

impl<'tu> PartialEq<File<'tu>> for File<'tu>

fn eq(&self, other: &File<'tu>) -> bool

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

impl<'tu> Copy for File<'tu>

impl<'tu> Eq for File<'tu>

Auto Trait Implementations

impl<'tu> RefUnwindSafe for File<'tu>

impl<'tu> !Send for File<'tu>

impl<'tu> !Sync for File<'tu>

impl<'tu> Unpin for File<'tu>

impl<'tu> UnwindSafe for File<'tu>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn get_id(&self) -> (u64, u64, u64 )

pub fn visit_includes<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>(
&self,
f: F
) -> bool

pub fn visit_references<F: FnMut(Entity<'tu>, SourceRange<'tu>) -> bool>(
&self,
entity: Entity<'tu>,
f: F
) -> bool

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,