Struct hir::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> InFileWrapper<HirFileId, FileAstId<N>>

where N: AstIdNode,

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, ) -> InFileWrapper<HirFileId, N>

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

impl InFileWrapper<HirFileId, ErasedFileAstId>

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

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

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

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

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

where F: FnOnce(T) -> U,

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

where FileKind: Copy,

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

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

pub fn borrow<U>(&self) -> InFileWrapper<FileKind, &U>

where T: Borrow<U>,

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

where FileKind: Copy, T: Clone,

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, T> InFileWrapper<FileId, T>

where FileId: FileIdToSyntax,

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

impl<FileId, N> InFileWrapper<FileId, N>

where FileId: Copy, N: AstNode,

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

impl<FileId, N> InFileWrapper<FileId, &N>

where FileId: Copy, N: AstNode,

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

impl<SN> InFileWrapper<EditionedFileId, SN>

where SN: Borrow<SyntaxNode<RustLanguage>>,

pub fn file_range(&self) -> FileRangeWrapper<EditionedFileId>

impl<SN> InFileWrapper<HirFileId, SN>

where SN: Borrow<SyntaxNode<RustLanguage>>,

pub fn parent_ancestors_with_macros( self, db: &dyn ExpandDatabase, ) -> impl Iterator<Item = InFileWrapper<HirFileId, SyntaxNode<RustLanguage>>>

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

pub fn kind(&self) -> SyntaxKind

pub fn text_range(&self) -> TextRange

pub fn original_file_range_rooted( self, db: &dyn ExpandDatabase, ) -> FileRangeWrapper<EditionedFileId>

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, ) -> FileRangeWrapper<EditionedFileId>

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

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

impl InFileWrapper<HirFileId, &SyntaxNode<RustLanguage>>

pub fn original_file_range_opt( self, db: &dyn ExpandDatabase, ) -> Option<(FileRangeWrapper<EditionedFileId>, SyntaxContextId)>

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

impl InFileWrapper<MacroFileId, SyntaxToken<RustLanguage>>

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

impl InFileWrapper<HirFileId, SyntaxToken<RustLanguage>>

pub fn original_file_range( self, db: &dyn ExpandDatabase, ) -> FileRangeWrapper<EditionedFileId>

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<FileRangeWrapper<EditionedFileId>>

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

impl InFileWrapper<MacroFileId, TextSize>

pub fn original_file_range( self, db: &dyn ExpandDatabase, ) -> (FileRangeWrapper<EditionedFileId>, SyntaxContextId)

impl InFileWrapper<HirFileId, TextRange>

pub fn original_node_file_range( self, db: &dyn ExpandDatabase, ) -> (FileRangeWrapper<EditionedFileId>, SyntaxContextId)

pub fn original_node_file_range_rooted( self, db: &dyn ExpandDatabase, ) -> FileRangeWrapper<EditionedFileId>

pub fn original_node_file_range_with_macro_call_body( self, db: &dyn ExpandDatabase, ) -> FileRangeWrapper<EditionedFileId>

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

impl<N> InFileWrapper<HirFileId, N>

where N: AstNode,

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

impl<T> InFileWrapper<HirFileId, T>

pub fn into_real_file( self, ) -> Result<InFileWrapper<EditionedFileId, T>, InFileWrapper<HirFileId, T>>

Trait Implementations

impl AsMacroCall for InFileWrapper<HirFileId, &MacroCall>

fn as_call_id_with_errors( &self, db: &dyn ExpandDatabase, krate: Idx<CrateData>, resolver: impl Fn(&ModPath) -> Option<MacroDefId> + Copy, ) -> Result<ValueResult<Option<MacroCallId>, ExpandError>, UnresolvedMacro>

fn as_call_id( &self, db: &dyn ExpandDatabase, krate: Idx<CrateData>, resolver: impl Fn(&ModPath) -> Option<MacroDefId> + Copy, ) -> Option<MacroCallId>

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

where FileKind: Clone, T: Clone,

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

where FileKind: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<T> From<InFileWrapper<EditionedFileId, T>> for InFileWrapper<HirFileId, T>

fn from(_: InFileWrapper<EditionedFileId, T>) -> InFileWrapper<HirFileId, T>

Converts to this type from the input type.

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

fn from(_: InFileWrapper<MacroFileId, T>) -> InFileWrapper<HirFileId, T>

Converts to this type from the input type.

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

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

where FileKind: PartialEq, T: PartialEq,

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

where FileKind: Copy, T: Copy,

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

where FileKind: Eq, T: Eq,

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