Enum Definition 

pub enum Definition<'db> {
    Macro(Macro),
    Field(Field),
    TupleField(TupleField<'db>),
    Module(Module),
    Crate(Crate),
    Function(Function),
    Adt(Adt),
    EnumVariant(EnumVariant),
    Const(Const),
    Static(Static),
    Trait(Trait),
    TypeAlias(TypeAlias),
    SelfType(Impl),
    GenericParam(GenericParam),
    Local(Local<'db>),
    Label(Label),
    DeriveHelper(DeriveHelper),
    BuiltinType(BuiltinType),
    BuiltinLifetime(StaticLifetime),
    BuiltinAttr(BuiltinAttr),
    ToolModule(ToolModule),
    ExternCrateDecl(ExternCrateDecl),
    InlineAsmRegOrRegClass(()),
    InlineAsmOperand(InlineAsmOperand),
}

Variants

Macro(Macro)

Field(Field)

TupleField(TupleField<'db>)

Module(Module)

Crate(Crate)

Function(Function)

Adt(Adt)

EnumVariant(EnumVariant)

Const(Const)

Static(Static)

Trait(Trait)

TypeAlias(TypeAlias)

SelfType(Impl)

GenericParam(GenericParam)

Local(Local<'db>)

Label(Label)

DeriveHelper(DeriveHelper)

BuiltinType(BuiltinType)

BuiltinLifetime(StaticLifetime)

BuiltinAttr(BuiltinAttr)

ToolModule(ToolModule)

ExternCrateDecl(ExternCrateDecl)

InlineAsmRegOrRegClass(())

InlineAsmOperand(InlineAsmOperand)

Implementations

impl<'db> Definition<'db>

pub fn canonical_module_path( &self, db: &RootDatabase, ) -> Option<impl Iterator<Item = Module>>

pub fn krate(&self, db: &RootDatabase) -> Option<Crate>

pub fn module(&self, db: &RootDatabase) -> Option<Module>

Returns the module this definition resides in.

As such, for modules themselves this will return the parent module.

pub fn enclosing_definition(&self, db: &RootDatabase) -> Option<Definition<'db>>

pub fn visibility(&self, db: &RootDatabase) -> Option<Visibility>

pub fn name(&self, db: &RootDatabase) -> Option<Name>

pub fn docs<'a>( &self, db: &'a RootDatabase, famous_defs: Option<&FamousDefs<'_, '_>>, display_target: DisplayTarget, ) -> Option<Documentation<'a>>

pub fn docs_with_rangemap<'a>( &self, db: &'a RootDatabase, famous_defs: Option<&FamousDefs<'_, '_>>, display_target: DisplayTarget, ) -> Option<Either<Cow<'a, Docs>, Documentation<'a>>>

pub fn label(&self, db: &RootDatabase, display_target: DisplayTarget) -> String

impl<'db> Definition<'db>

pub fn rename( &self, sema: &Semantics<'db, RootDatabase>, new_name: &str, rename_definition: RenameDefinition, config: &RenameConfig, ) -> Result<SourceChange>

pub fn range_for_rename( self, sema: &Semantics<'_, RootDatabase>, ) -> Option<FileRange>

Textual range of the identifier which will change when renaming this Definition. Note that builtin types can’t be renamed and extern crate names will report its range, though a rename will introduce an alias instead.

impl<'db> Definition<'db>

fn search_scope(&self, db: &RootDatabase) -> SearchScope

pub fn usages<'a>( self, sema: &'a Semantics<'db, RootDatabase>, ) -> FindUsages<'a, 'db>

Trait Implementations

impl AsAssocItem for Definition<'_>

fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>

impl AsExternAssocItem for Definition<'_>

fn as_extern_assoc_item(self, db: &dyn HirDatabase) -> Option<ExternAssocItem>

impl<'db> Clone for Definition<'db>

fn clone(&self) -> Definition<'db>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'db> Debug for Definition<'db>

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

Formats the value using the given formatter.

impl<'db> From<Adt> for Definition<'db>

fn from(it: Adt) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<AssocItem> for Definition<'db>

fn from(assoc_item: AssocItem) -> Self

Converts to this type from the input type.

impl<'db> From<BuiltinType> for Definition<'db>

fn from(it: BuiltinType) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Const> for Definition<'db>

fn from(it: Const) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<DocLinkDef> for Definition<'db>

fn from(def: DocLinkDef) -> Self

Converts to this type from the input type.

impl<'db> From<Either<PathResolution<'db>, InlineAsmOperand>> for Definition<'db>

fn from(value: Either<PathResolution<'db>, InlineAsmOperand>) -> Self

Converts to this type from the input type.

impl<'db> From<EnumVariant> for Definition<'db>

fn from(it: EnumVariant) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<ExternCrateDecl> for Definition<'db>

fn from(it: ExternCrateDecl) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Field> for Definition<'db>

fn from(it: Field) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Function> for Definition<'db>

fn from(it: Function) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<GenericDef> for Definition<'db>

fn from(def: GenericDef) -> Self

Converts to this type from the input type.

impl<'db> From<GenericParam> for Definition<'db>

fn from(it: GenericParam) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Impl> for Definition<'db>

fn from(impl_: Impl) -> Self

Converts to this type from the input type.

impl<'db> From<InlineAsmOperand> for Definition<'db>

fn from(it: InlineAsmOperand) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Label> for Definition<'db>

fn from(it: Label) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Local<'db>> for Definition<'db>

fn from(it: Local<'db>) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Macro> for Definition<'db>

fn from(it: Macro) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Module> for Definition<'db>

fn from(it: Module) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<ModuleDef> for Definition<'db>

fn from(def: ModuleDef) -> Self

Converts to this type from the input type.

impl<'db> From<PathResolution<'db>> for Definition<'db>

fn from(path_resolution: PathResolution<'db>) -> Self

Converts to this type from the input type.

impl<'db> From<Static> for Definition<'db>

fn from(it: Static) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Trait> for Definition<'db>

fn from(it: Trait) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<TupleField<'db>> for Definition<'db>

fn from(it: TupleField<'db>) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<TypeAlias> for Definition<'db>

fn from(it: TypeAlias) -> Definition<'db>

Converts to this type from the input type.

impl<'db> From<Variant> for Definition<'db>

fn from(def: Variant) -> Self

Converts to this type from the input type.

impl<'db> Hash for Definition<'db>

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<'db> PartialEq for Definition<'db>

fn eq(&self, other: &Definition<'db>) -> 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<'db> TryFrom<DefWithBody> for Definition<'db>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(def: DefWithBody) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Definition<'_>> for GenericDef

type Error = ()

The type returned in the event of a conversion error.

fn try_from(def: Definition<'_>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'db> TryFrom<ExpressionStoreOwner> for Definition<'db>

type Error = ()

The type returned in the event of a conversion error.

fn try_from(def: ExpressionStoreOwner) -> Result<Self, Self::Error>

Performs the conversion.

impl<'db> Copy for Definition<'db>

impl<'db> Eq for Definition<'db>

impl<'db> StructuralPartialEq for Definition<'db>