encode_cross_crate.rs

use crate::attrs::AttributeKind;

#[derive(PartialEq)]
pub enum EncodeCrossCrate {
    Yes,
    No,
}

impl AttributeKind {
    /// Whether this attribute should be encoded in metadata files.
    ///
    /// If this is "Yes", then another crate can do `tcx.get_all_attrs(did)` for a did in this crate, and get the attribute.
    /// When this is No, the attribute is filtered out while encoding and other crate won't be able to observe it.
    /// This can be unexpectedly good for performance, so unless necessary for cross-crate compilation, prefer No.
    pub fn encode_cross_crate(&self) -> EncodeCrossCrate {
        use AttributeKind::*;
        use EncodeCrossCrate::*;

        match self {
            // tidy-alphabetical-start
            Align { .. } => No,
            AllowInternalUnsafe(..) => Yes,
            AllowInternalUnstable(..) => Yes,
            AutomaticallyDerived(..) => Yes,
            CfgAttrTrace => Yes,
            CfgTrace(..) => Yes,
            CfiEncoding { .. } => Yes,
            Cold(..) => No,
            CollapseDebugInfo(..) => Yes,
            CompilerBuiltins => No,
            ConstContinue(..) => No,
            Coroutine(..) => No,
            Coverage(..) => No,
            CrateName { .. } => No,
            CrateType(_) => No,
            CustomMir(_, _, _) => Yes,
            DebuggerVisualizer(..) => No,
            DefaultLibAllocator => No,
            Deprecation { .. } => Yes,
            DoNotRecommend { .. } => Yes,
            Doc(_) => Yes,
            DocComment { .. } => Yes,
            EiiDeclaration(_) => Yes,
            EiiForeignItem => No,
            EiiImpls(..) => No,
            ExportName { .. } => Yes,
            ExportStable => No,
            Feature(..) => No,
            FfiConst(..) => No,
            FfiPure(..) => No,
            Fundamental { .. } => Yes,
            Ignore { .. } => No,
            Inline(..) => No,
            InstructionSet(..) => No,
            Lang(..) => Yes,
            Link(..) => No,
            LinkName { .. } => Yes, // Needed for rustdoc
            LinkOrdinal { .. } => No,
            LinkSection { .. } => Yes, // Needed for rustdoc
            Linkage(..) => No,
            LoopMatch(..) => No,
            MacroEscape(..) => No,
            MacroExport { .. } => Yes,
            MacroUse { .. } => No,
            Marker(..) => No,
            MayDangle(..) => No,
            MoveSizeLimit { .. } => No,
            MustNotSupend { .. } => Yes,
            MustUse { .. } => Yes,
            Naked(..) => No,
            NeedsAllocator => No,
            NeedsPanicRuntime => No,
            NoBuiltins => Yes,
            NoCore(..) => No,
            NoImplicitPrelude(..) => No,
            NoLink => No,
            NoMain => No,
            NoMangle(..) => Yes, // Needed for rustdoc
            NoStd(..) => No,
            NonExhaustive(..) => Yes, // Needed for rustdoc
            Optimize(..) => No,
            PanicRuntime => No,
            PatchableFunctionEntry { .. } => Yes,
            Path(..) => No,
            PatternComplexityLimit { .. } => No,
            PinV2(..) => Yes,
            Pointee(..) => No,
            PreludeImport => No,
            ProcMacro(..) => No,
            ProcMacroAttribute(..) => No,
            ProcMacroDerive { .. } => No,
            ProfilerRuntime => No,
            RecursionLimit { .. } => No,
            ReexportTestHarnessMain(..) => No,
            Repr { .. } => No,
            RustcAbi { .. } => No,
            RustcAllocator => No,
            RustcAllocatorZeroed => No,
            RustcAllocatorZeroedVariant { .. } => Yes,
            RustcAllowConstFnUnstable(..) => No,
            RustcAllowIncoherentImpl(..) => No,
            RustcAsPtr(..) => Yes,
            RustcBodyStability { .. } => No,
            RustcBuiltinMacro { .. } => Yes,
            RustcCaptureAnalysis => No,
            RustcCguTestAttr { .. } => No,
            RustcClean { .. } => No,
            RustcCoherenceIsCore(..) => No,
            RustcCoinductive(..) => No,
            RustcConfusables { .. } => Yes,
            RustcConstStability { .. } => Yes,
            RustcConstStabilityIndirect => No,
            RustcConversionSuggestion => Yes,
            RustcDeallocator => No,
            RustcDefPath(..) => No,
            RustcDelayedBugFromInsideQuery => No,
            RustcDenyExplicitImpl(..) => No,
            RustcDeprecatedSafe2024 { .. } => Yes,
            RustcDiagnosticItem(..) => Yes,
            RustcDoNotConstCheck => Yes,
            RustcDocPrimitive(..) => Yes,
            RustcDummy => No,
            RustcDumpDefParents => No,
            RustcDumpItemBounds => No,
            RustcDumpPredicates => No,
            RustcDumpUserArgs => No,
            RustcDumpVtable(..) => No,
            RustcDynIncompatibleTrait(..) => No,
            RustcEffectiveVisibility => Yes,
            RustcEvaluateWhereClauses => Yes,
            RustcHasIncoherentInherentImpls => Yes,
            RustcHiddenTypeOfOpaques => No,
            RustcIfThisChanged(..) => No,
            RustcInsignificantDtor => Yes,
            RustcIntrinsic => Yes,
            RustcIntrinsicConstStableIndirect => No,
            RustcLayout(..) => No,
            RustcLayoutScalarValidRangeEnd(..) => Yes,
            RustcLayoutScalarValidRangeStart(..) => Yes,
            RustcLegacyConstGenerics { .. } => Yes,
            RustcLintOptDenyFieldAccess { .. } => Yes,
            RustcLintOptTy => Yes,
            RustcLintQueryInstability => Yes,
            RustcLintUntrackedQueryInformation => Yes,
            RustcMacroTransparency(..) => Yes,
            RustcMain => No,
            RustcMir(..) => Yes,
            RustcMustImplementOneOf { .. } => No,
            RustcNeverReturnsNullPointer => Yes,
            RustcNeverTypeOptions { .. } => No,
            RustcNoImplicitAutorefs => Yes,
            RustcNoImplicitBounds => No,
            RustcNoMirInline => Yes,
            RustcNonConstTraitMethod => No, // should be reported via other queries like `constness`
            RustcNonnullOptimizationGuaranteed => Yes,
            RustcNounwind => No,
            RustcObjcClass { .. } => No,
            RustcObjcSelector { .. } => No,
            RustcObjectLifetimeDefault => No,
            RustcOffloadKernel => Yes,
            RustcOutlives => No,
            RustcParenSugar(..) => No,
            RustcPassByValue(..) => Yes,
            RustcPassIndirectlyInNonRusticAbis(..) => No,
            RustcPreserveUbChecks => No,
            RustcProcMacroDecls => No,
            RustcPubTransparent(..) => Yes,
            RustcReallocator => No,
            RustcRegions => No,
            RustcReservationImpl(..) => Yes,
            RustcScalableVector { .. } => Yes,
            RustcShouldNotBeCalledOnConstItems(..) => Yes,
            RustcSimdMonomorphizeLaneLimit(..) => Yes, // Affects layout computation, which needs to work cross-crate
            RustcSkipDuringMethodDispatch { .. } => No,
            RustcSpecializationTrait(..) => No,
            RustcStdInternalSymbol(..) => No,
            RustcStrictCoherence(..) => Yes,
            RustcSymbolName(..) => Yes,
            RustcTestMarker(..) => No,
            RustcThenThisWouldNeed(..) => No,
            RustcTrivialFieldReads => Yes,
            RustcUnsafeSpecializationMarker(..) => No,
            RustcVariance => No,
            RustcVarianceOfOpaques => No,
            Sanitize { .. } => No,
            ShouldPanic { .. } => No,
            Stability { .. } => Yes,
            TargetFeature { .. } => No,
            TestRunner(..) => Yes,
            ThreadLocal => No,
            TrackCaller(..) => Yes,
            TypeLengthLimit { .. } => No,
            UnstableFeatureBound(..) => No,
            Used { .. } => No,
            WindowsSubsystem(..) => No,
            // tidy-alphabetical-end
        }
    }
}