Struct hir_expand::files::InFileWrapper

pub struct InFileWrapper<FileKind, T> {
    pub file_id: FileKind,
    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: FileKind

value: T

Implementations

impl<N: AstIdNode> InFileWrapper<HirFileId, FileAstId<N>>

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

pub fn to_range(&self, db: &dyn ExpandDatabase) -> TextRange

pub fn to_in_file_node(&self, db: &dyn ExpandDatabase) -> InFile<N>

pub fn to_ptr(&self, db: &dyn ExpandDatabase) -> AstPtr<N>

impl InFileWrapper<HirFileId, Idx<SyntaxNodePtr<RustLanguage>>>

pub fn to_range(&self, db: &dyn ExpandDatabase) -> TextRange

pub fn to_ptr(&self, db: &dyn ExpandDatabase) -> SyntaxNodePtr

impl<FileKind, T> InFileWrapper<FileKind, T>

pub fn new(file_id: FileKind, value: T) -> Self

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

impl<FileKind: Copy, T> InFileWrapper<FileKind, T>

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

pub fn as_ref(&self) -> InFileWrapper<FileKind, &T>

impl<FileKind: Copy, T: Clone> InFileWrapper<FileKind, &T>

pub fn cloned(&self) -> InFileWrapper<FileKind, T>

impl<FileKind, T> InFileWrapper<FileKind, Option<T>>

pub fn transpose(self) -> Option<InFileWrapper<FileKind, T>>

impl<FileKind, L, R> InFileWrapper<FileKind, Either<L, R>>

pub fn transpose( self ) -> Either<InFileWrapper<FileKind, L>, InFileWrapper<FileKind, R>>

impl<FileId: FileIdToSyntax, T> InFileWrapper<FileId, T>

pub fn file_syntax(&self, db: &dyn ExpandDatabase) -> SyntaxNode

impl<FileId: Copy, N: AstNode> InFileWrapper<FileId, N>

pub fn syntax(&self) -> InFileWrapper<FileId, &SyntaxNode>

impl InFileWrapper<HirFileId, &SyntaxNode<RustLanguage>>

pub fn ancestors_with_macros_skip_attr_item( self, db: &dyn ExpandDatabase ) -> impl Iterator<Item = InFile<SyntaxNode>> + '_

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

pub fn original_file_range_rooted(self, db: &dyn ExpandDatabase) -> 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 use [InFile::original_file_range_full].

pub fn original_file_range_with_macro_call_body( self, db: &dyn ExpandDatabase ) -> 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 ExpandDatabase ) -> Option<(FileRange, SyntaxContextId)>

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

pub fn original_syntax_node_rooted( self, db: &dyn ExpandDatabase ) -> Option<InRealFile<SyntaxNode>>

impl InFileWrapper<MacroFileId, SyntaxToken<RustLanguage>>

pub fn upmap_once( self, db: &dyn ExpandDatabase ) -> InFile<SmallVec<[TextRange; 1]>>

impl InFileWrapper<HirFileId, SyntaxToken<RustLanguage>>

pub fn original_file_range(self, db: &dyn ExpandDatabase) -> 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 ExpandDatabase ) -> Option<FileRange>

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

impl InFileWrapper<MacroFileId, TextSize>

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

impl InFileWrapper<HirFileId, TextRange>

pub fn original_node_file_range( self, db: &dyn ExpandDatabase ) -> (FileRange, SyntaxContextId)

pub fn original_node_file_range_rooted( self, db: &dyn ExpandDatabase ) -> FileRange

pub fn original_node_file_range_with_macro_call_body( self, db: &dyn ExpandDatabase ) -> FileRange

pub fn original_node_file_range_opt( self, db: &dyn ExpandDatabase ) -> Option<(FileRange, SyntaxContextId)>

impl<N: AstNode> InFileWrapper<HirFileId, N>

pub fn original_ast_node_rooted( self, db: &dyn ExpandDatabase ) -> Option<InRealFile<N>>

Trait Implementations

impl<FileKind: Clone, T: Clone> Clone for InFileWrapper<FileKind, T>

fn clone(&self) -> InFileWrapper<FileKind, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<FileKind: Debug, T: Debug> Debug for InFileWrapper<FileKind, T>

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

Formats the value using the given formatter.

impl<T> From<InFileWrapper<FileId, T>> for InFile<T>

fn from(_: InRealFile<T>) -> Self

Converts to this type from the input type.

impl<T> From<InFileWrapper<MacroFileId, T>> for InFile<T>

fn from(_: InMacroFile<T>) -> Self

Converts to this type from the input type.

impl<FileKind: Hash, T: Hash> Hash for InFileWrapper<FileKind, T>

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<FileKind: PartialEq, T: PartialEq> PartialEq for InFileWrapper<FileKind, T>

fn eq(&self, other: &InFileWrapper<FileKind, 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<FileKind: Copy, T: Copy> Copy for InFileWrapper<FileKind, T>

impl<FileKind: Eq, T: Eq> Eq for InFileWrapper<FileKind, T>

impl<FileKind, T> StructuralPartialEq for InFileWrapper<FileKind, T>