Skip to main content

ExportSymbol

Struct ExportSymbol 

Source
pub struct ExportSymbol {
    pub name: ExportName,
    pub is_type_only: bool,
    pub is_side_effect_used: bool,
    pub visibility: VisibilityTag,
    pub expected_unused_reason: Option<String>,
    pub deprecated: bool,
    pub deprecated_reason: Option<Box<str>>,
    pub span: Span,
    pub references: Vec<SymbolReference>,
    pub reference_paths: Vec<Option<ReferencePathId>>,
    pub members: Vec<MemberInfo>,
}
Expand description

An export with reference tracking.

Fields§

§name: ExportName

The exported name (named or default).

§is_type_only: bool

Whether this is a type-only export.

§is_side_effect_used: bool

Whether this export is registered through a runtime side effect at module load time (e.g. a Lit @customElement('tag') decorator or a customElements.define('tag', ClassRef) call). The unused-export detector treats this as an effective reference.

§visibility: VisibilityTag

Visibility tag from JSDoc/TSDoc comment (@public, @internal, @alpha, @beta). Exports with any visibility tag are never reported as unused.

§expected_unused_reason: Option<String>

Human-authored reason on @expected-unused -- <reason>, when present.

§deprecated: bool

Whether the leading JSDoc carries a @deprecated tag.

§deprecated_reason: Option<Box<str>>

Plain-text @deprecated message, None for a bare tag.

§span: Span

Source span of the export declaration.

§references: Vec<SymbolReference>

Which files reference this export.

§reference_paths: Vec<Option<ReferencePathId>>

Interned provenance paths parallel to references, keyed by reference index (issue #2083).

Only populated when the test-reachability plan requires reference provenance (a replacement mock exists). It stays empty for every other project so the reference list itself remains 16 bytes per entry and the side table allocates nothing. Entries can be None even when populated: legacy reachability stores no path, profiled reachability always does.

§members: Vec<MemberInfo>

Members of this export (enum members, class members).

MemberInfo is a shared fallow-types struct whose serde shape is serialize-only (its span uses serialize_with with no matching deserializer), so it cannot round-trip through a plain derive. The cache routes it through a dedicated lossless mirror in crate::cache.

Implementations§

Source§

impl ExportSymbol

Source

pub fn references_in( &self, namespace: ExportNamespace, ) -> impl Iterator<Item = &SymbolReference>

References that use one semantic namespace.

Source

pub fn physical_references(&self) -> impl Iterator<Item = &SymbolReference>

Distinct physical reference sites, collapsing Type and Value uses of the same import while preserving different resolved routes.

Trait Implementations§

Source§

impl Debug for ExportSymbol

Source§

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

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

impl<'de> Deserialize<'de> for ExportSymbol

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ExportSymbol, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ExportSymbol

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more