Skip to main content

ComponentProp

Struct ComponentProp 

Source
pub struct ComponentProp {
    pub name: String,
    pub local: String,
    pub span_start: u32,
    pub used_in_script: bool,
    pub used_in_template: bool,
    pub component: String,
    pub used_outside_forward: bool,
}
Expand description

A component prop declared by Vue <script setup> defineProps or Svelte 5 $props(). used_in_script / used_in_template are set during extraction; the unused-component-prop detector flags a prop where neither is true. See harvest_define_props and harvest_svelte_props in sfc_props.rs.

Fields§

§name: String

The declared prop name.

§local: String

The template/script-visible local binding name: the destructure alias for const { name: alias } = defineProps() or let { name: alias } = $props(), otherwise the prop name itself. A renamed prop is read through this local, so usage must be checked against it, not the declared name.

§span_start: u32

Start byte offset of the prop declaration (anchors the finding).

§used_in_script: bool

Whether this prop is referenced in the component’s <script> (a destructured local binding with a resolved reference, or a props.<name> member access). For React, this is set-in-body: a resolved reference to the destructured local anywhere in the component function body.

§used_in_template: bool

Whether this prop name is referenced in the component’s <template>. Set by apply_template_usage when the template scanner credits the name. Always false for React (no template; React uses used_in_script).

§component: String

The enclosing component name. Empty for Vue SFCs (one component per file, the file stem is the component, set by the detector). For React this is the component function/arrow name a prop was declared on, so the detector can emit the right component_name and apply the per-component abstain ladder (a file can declare several React components).

§used_outside_forward: bool

React-only: true when the destructured prop local is referenced at least once OUTSIDE a child-JSX attribute value expression (a substantive consumption: a hook arg, a host-element child, a non-JSX-attr read). When used_in_script is true but this is false, the prop is referenced ONLY as the root of forwarded child attribute values, i.e. a pure pass-through. Always false for Vue (no forward-vs-consume distinction is computed).

Trait Implementations§

Source§

impl Clone for ComponentProp

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ComponentProp

Source§

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

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

impl<'__de> Decode<'__de> for ComponentProp
where '__de:,

Source§

impl Encode for ComponentProp

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DecodeOwned for T
where T: for<'de> Decode<'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, 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<'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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.