Struct 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 InFileWrapper<HirFileId, FileAstId<Macro>>

pub fn decl_macro_expander<'db>( self: AstId<Macro>, db: &'db dyn SourceDatabase, def_crate: Crate, ) -> &'db DeclarativeMacroExpander

Fetches (and compiles) the expander of this decl macro.

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

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

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

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

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

pub fn erase(&self) -> ErasedAstId

pub fn upcast<M: AstIdNode>(self) -> AstId<M>

where N: Into<M>,

impl InFileWrapper<HirFileId, ErasedFileAstId>

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

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

impl<FileKind, N: AstNode> InFileWrapper<FileKind, AstPtr<N>>

pub fn upcast<M: AstNode>(self) -> InFileWrapper<FileKind, AstPtr<M>>

where N: Into<M>,

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>

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

where T: Borrow<U>,

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 SourceDatabase) -> SyntaxNode

impl<FileId: FileIdToSyntax, N: AstNode> InFileWrapper<FileId, AstPtr<N>>

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

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

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

pub fn node_file_range(&self) -> FileRangeWrapper<FileId>

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

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

impl<FileId: Copy, SN: Borrow<SyntaxNode>> InFileWrapper<FileId, SN>

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

impl<SN: Borrow<SyntaxNode>> InFileWrapper<HirFileId, SN>

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

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

pub fn kind(&self) -> SyntaxKind

pub fn text_range(&self) -> TextRange

pub fn original_file_range_rooted(self, db: &dyn SourceDatabase) -> 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_input( self, db: &dyn SourceDatabase, ) -> FileRange

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

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

impl InFileWrapper<HirFileId, &SyntaxNode<RustLanguage>>

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

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

impl InFileWrapper<MacroCallId, SyntaxToken<RustLanguage>>

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

impl InFileWrapper<HirFileId, SyntaxToken<RustLanguage>>

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

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

impl InFileWrapper<MacroCallId, TextSize>

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

impl InFileWrapper<HirFileId, TextRange>

pub fn original_node_file_range( self, db: &dyn SourceDatabase, ) -> (FileRange, SyntaxContext)

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

pub fn original_node_file_range_with_macro_call_input( self, db: &dyn SourceDatabase, ) -> FileRange

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

pub fn original_node_file_range_rooted_opt( self, db: &dyn SourceDatabase, ) -> Option<FileRange>

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

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

impl<T> InFileWrapper<HirFileId, T>

pub fn into_real_file(self) -> Result<InRealFile<T>, InFile<T>>

Trait Implementations

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

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

Returns a duplicate 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<EditionedFileId, T>> for InFile<T>

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

Converts to this type from the input type.

impl<T> From<InFileWrapper<MacroCallId, 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

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: 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>