Struct ra_ap_hir::InFile

pub struct InFile<T> {
    pub file_id: HirFileId,
    pub value: T,
}

InFile<T> stores a value of T inside a particular file/syntax tree.

Typical usages are:

• InFile<SyntaxNode> – syntax node in a file
• InFile<ast::FnDef> – ast node in a file
• InFile<TextSize> – offset in a file

Fields

file_id: HirFileId

value: T

Implementations

impl<N> InFile<FileAstId<N>>where
    N: AstNode,

pub fn to_node(&self, db: &dyn AstDatabase) -> N

impl<T> InFile<T>

pub fn new(file_id: HirFileId, value: T) -> InFile<T>

pub fn with_value<U>(&self, value: U) -> InFile<U>

pub fn map<F, U>(self, f: F) -> InFile<U>where
    F: FnOnce(T) -> U,

pub fn as_ref(&self) -> InFile<&T>

pub fn file_syntax(&self, db: &dyn AstDatabase) -> SyntaxNode<RustLanguage>

impl<T> InFile<&T>where
    T: Clone,

pub fn cloned(&self) -> InFile<T>

impl<T> InFile<Option<T>>

pub fn transpose(self) -> Option<InFile<T>>

impl<'a> InFile<&'a SyntaxNode<RustLanguage>>

pub fn ancestors_with_macros(
    self,
    db: &dyn AstDatabase
) -> impl Iterator<Item = InFile<SyntaxNode<RustLanguage>>> + Clone

pub fn ancestors_with_macros_skip_attr_item(
    self,
    db: &dyn AstDatabase
) -> impl Iterator<Item = InFile<SyntaxNode<RustLanguage>>>

Skips the attributed item that caused the macro invocation we are climbing up

pub fn original_file_range(self, db: &dyn AstDatabase) -> FileRange

Falls back to the macro call range if the node cannot be mapped up fully.

For attributes and derives, this will point back to the attribute only. For the entire item InFile::use original_file_range_full.

pub fn original_file_range_opt(self, db: &dyn AstDatabase) -> Option<FileRange>

Attempts to map the syntax node back up its macro calls.

pub fn original_syntax_node(
    self,
    db: &dyn AstDatabase
) -> Option<InFile<SyntaxNode<RustLanguage>>>

impl InFile<SyntaxToken<RustLanguage>>

pub fn upmap(
    self,
    db: &dyn AstDatabase
) -> Option<InFile<SyntaxToken<RustLanguage>>>

pub fn original_file_range(self, db: &dyn AstDatabase) -> FileRange

Falls back to the macro call range if the node cannot be mapped up fully.

pub fn original_file_range_opt(self, db: &dyn AstDatabase) -> Option<FileRange>

Attempts to map the syntax node back up its macro calls.

pub fn ancestors_with_macros(
    self,
    db: &dyn AstDatabase
) -> impl Iterator<Item = InFile<SyntaxNode<RustLanguage>>>

impl<N> InFile<N>where
    N: AstNode,

pub fn descendants<T>(self) -> impl Iterator<Item = InFile<T>>where
    T: AstNode,

pub fn original_ast_node(self, db: &dyn AstDatabase) -> Option<InFile<N>>

pub fn syntax(&self) -> InFile<&SyntaxNode<RustLanguage>>

Trait Implementations

impl AsMacroCall for InFile<&MacroCall>

fn as_call_id_with_errors(
    &self,
    db: &dyn DefDatabase,
    krate: CrateId,
    resolver: impl Fn(ModPath) -> Option<MacroDefId>,
    error_sink: &mut dyn FnMut(ExpandError)
) -> Result<Result<MacroCallId, ErrorEmitted>, UnresolvedMacro>

fn as_call_id(
    &self,
    db: &dyn DefDatabase,
    krate: CrateId,
    resolver: impl Fn(ModPath) -> Option<MacroDefId>
) -> Option<MacroCallId>

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

fn clone(&self) -> InFile<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for InFile<T>where
    T: Debug,

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

Formats the value using the given formatter.

impl<T> Hash for InFile<T>where
    T: Hash,

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

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<T> PartialEq<InFile<T>> for InFile<T>where
    T: PartialEq<T>,

fn eq(&self, other: &InFile<T>) -> 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<T> Copy for InFile<T>where
    T: Copy,

impl<T> Eq for InFile<T>where
    T: Eq,

impl<T> StructuralEq for InFile<T>

impl<T> StructuralPartialEq for InFile<T>