Type Alias Res

Source
type Res = Res<NodeId>;

Aliased Type§

enum Res {
    Def(DefKind, DefId),
    PrimTy(PrimTy),
    SelfTyParam {
        trait_: DefId,
    },
    SelfTyAlias {
        alias_to: DefId,
        forbid_generic: bool,
        is_trait_impl: bool,
    },
    SelfCtor(DefId),
    Local(NodeId),
    ToolMod,
    NonMacroAttr(NonMacroAttrKind),
    Err,
}

Variants§

§

Def(DefKind, DefId)

Definition having a unique ID (DefId), corresponds to something defined in user code.

Not bound to a specific namespace.

§

PrimTy(PrimTy)

A primitive type such as i32 or str.

Belongs to the type namespace.

§

SelfTyParam

The Self type, as used within a trait.

Belongs to the type namespace.

See the examples on [Res::SelfTyAlias] for details.

Fields

§trait_: DefId

The trait this Self is a generic parameter for.

§

SelfTyAlias

The Self type, as used somewhere other than within a trait.

Belongs to the type namespace.

Examples:

struct Bar(Box<Self>); // SelfTyAlias

trait Foo {
    fn foo() -> Box<Self>; // SelfTyParam
}

impl Bar {
    fn blah() {
        let _: Self; // SelfTyAlias
    }
}

impl Foo for Bar {
    fn foo() -> Box<Self> { // SelfTyAlias
        let _: Self;        // SelfTyAlias

        todo!()
    }
}

See also [Res::SelfCtor].

Fields

§alias_to: DefId

The item introducing the Self type alias. Can be used in the type_of query to get the underlying type.

§forbid_generic: bool

Whether the Self type is disallowed from mentioning generics (i.e. when used in an anonymous constant).

HACK(min_const_generics): self types also have an optional requirement to not mention any generic parameters to allow the following with min_const_generics:

impl Foo { fn test() -> [u8; std::mem::size_of::<Self>()] { todo!() } }

struct Bar([u8; baz::<Self>()]);
const fn baz<T>() -> usize { 10 }

We do however allow Self in repeat expression even if it is generic to not break code which already works on stable while causing the const_evaluatable_unchecked future compat lint:

fn foo<T>() {
    let _bar = [1_u8; std::mem::size_of::<*mut T>()];
}
§is_trait_impl: bool

Is this within an impl Foo for bar?

§

SelfCtor(DefId)

The Self constructor, along with the [DefId] of the impl it is associated with.

Belongs to the value namespace.

See also [Res::SelfTyParam] and [Res::SelfTyAlias].

§

Local(NodeId)

A local variable or function parameter.

Belongs to the value namespace.

§

ToolMod

A tool attribute module; e.g., the rustfmt in #[rustfmt::skip].

Belongs to the type namespace.

§

NonMacroAttr(NonMacroAttrKind)

An attribute that is not implemented via macro. E.g., #[inline] and #[rustfmt::skip], which are essentially directives, as opposed to #[test], which is a builtin macro.

Belongs to the macro namespace.

§

Err

Name resolution failed. We use a dummy Res variant so later phases of the compiler won’t crash and can instead report more errors.

Not bound to a specific namespace.

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 12 bytes

Size for each variant:

  • Def: 11 bytes
  • PrimTy: 2 bytes
  • SelfTyParam: 11 bytes
  • SelfTyAlias: 11 bytes
  • SelfCtor: 11 bytes
  • Local: 7 bytes
  • ToolMod: 0 bytes
  • NonMacroAttr: 7 bytes
  • Err: 0 bytes

Implementations

Source§

impl<Id> Res<Id>

Source

pub fn def_id(&self) -> DefId
where Id: Debug,

Return the DefId of this Def if it has an ID, else panic.

Source

pub fn opt_def_id(&self) -> Option<DefId>

Return Some(..) with the DefId of this Res if it has a ID, else None.

Source

pub fn mod_def_id(&self) -> Option<DefId>

Return the DefId of this Res if it represents a module.

Source

pub fn descr(&self) -> &'static str

A human readable name for the res kind (“function”, “module”, etc.).

Source

pub fn article(&self) -> &'static str

Gets an English article for the Res.

Source

pub fn map_id<R>(self, map: impl FnMut(Id) -> R) -> Res<R>

Source

pub fn apply_id<R, E>( self, map: impl FnMut(Id) -> Result<R, E>, ) -> Result<Res<R>, E>

Source

pub fn expect_non_local<OtherId>(self) -> Res<OtherId>

Source

pub fn macro_kind(self) -> Option<MacroKind>

Source

pub fn ns(&self) -> Option<Namespace>

Returns None if this is Res::Err

Source

pub fn matches_ns(&self, ns: Namespace) -> bool

Always returns true if self is Res::Err

Source

pub fn expected_in_tuple_struct_pat(&self) -> bool

Returns whether such a resolved path can occur in a tuple struct/variant pattern

Source

pub fn expected_in_unit_struct_pat(&self) -> bool

Returns whether such a resolved path can occur in a unit struct/variant pattern

Trait Implementations

Source§

impl<Id> Clone for Res<Id>
where Id: Clone,

Source§

fn clone(&self) -> Res<Id>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Id> Debug for Res<Id>
where Id: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<Id, __D> Decodable<__D> for Res<Id>
where __D: SpanDecoder, Id: Decodable<__D>,

Source§

fn decode(__decoder: &mut __D) -> Res<Id>

Source§

impl<Id, __E> Encodable<__E> for Res<Id>
where __E: SpanEncoder, Id: Encodable<__E>,

Source§

fn encode(&self, __encoder: &mut __E)

Source§

impl<Id> Hash for Res<Id>
where Id: Hash,

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Id, __CTX> HashStable<__CTX> for Res<Id>
where __CTX: HashStableContext, Id: HashStable<__CTX>,

Source§

fn hash_stable( &self, __hcx: &mut __CTX, __hasher: &mut StableHasher<SipHasher128>, )

Source§

impl<Id> IntoDiagArg for Res<Id>

Source§

impl<Id> PartialEq for Res<Id>
where Id: PartialEq,

Source§

fn eq(&self, other: &Res<Id>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Id> Copy for Res<Id>
where Id: Copy,

Source§

impl<Id> Eq for Res<Id>
where Id: Eq,

Source§

impl<Id> StructuralPartialEq for Res<Id>