Struct DeprecatedExportInUse 

pub struct DeprecatedExportInUse {
    pub path: PathBuf,
    pub export_name: String,
    pub is_type_only: bool,
    pub line: u32,
    pub col: u32,
    pub span_start: u32,
    pub deprecated_reason: Option<String>,
    pub consumer_count: usize,
    pub consumers: Vec<DeprecatedExportConsumer>,
    pub public_api: bool,
}

An export whose leading JSDoc carries @deprecated and that still has at least one consumer in a reachable file.

Fields

path: PathBuf

File that declares the deprecated export.

export_name: String

Name of the deprecated export.

is_type_only: bool

Whether this is a type-only export.

line: u32

1-based line number of the export.

col: u32

0-based byte column offset of the export.

span_start: u32

Byte offset of the export in the source file.

deprecated_reason: Option<String>

Plain-text message of the @deprecated tag, capped at DEPRECATED_REASON_MAX_CHARS characters. Absent when the tag carries no text.

consumer_count: usize

Exact number of distinct consumers: reference sites in reachable files, one per path, line, column and kind. consumers holds the first DEPRECATED_CONSUMER_SAMPLE_CAP of them, so the sample is complete when this count is at most the cap.

consumers: Vec<DeprecatedExportConsumer>

Consumer sample sorted by path, line, column and kind, capped at DEPRECATED_CONSUMER_SAMPLE_CAP entries.

public_api: bool

True when the export is part of the public API: it lives in an entry point, or a re-export chain reaches an entry point. External consumers are not visible, so the finding makes no removal claim.

Implementations

impl DeprecatedExportInUse

pub fn description(&self) -> String

One-line plain-text description shared by the SARIF and CodeClimate formats.

Trait Implementations

impl Clone for DeprecatedExportInUse

fn clone(&self) -> DeprecatedExportInUse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeprecatedExportInUse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeprecatedExportInUse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DeprecatedExportInUse

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for DeprecatedExportInUse

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.