ExtractedSymbol

Struct ExtractedSymbol 

Source
pub struct ExtractedSymbol {
Show 19 fields pub name: String, pub qualified_name: Option<String>, pub kind: SymbolKind, pub start_line: usize, pub end_line: usize, pub start_col: usize, pub end_col: usize, pub signature: Option<String>, pub visibility: Visibility, pub doc_comment: Option<String>, pub parent: Option<String>, pub type_info: Option<String>, pub parameters: Vec<Parameter>, pub return_type: Option<String>, pub exported: bool, pub is_async: bool, pub is_static: bool, pub generics: Vec<String>, pub definition_start_line: Option<usize>,
}
Expand description

A symbol extracted from AST parsing

Fields§

§name: String

Symbol name (e.g., “main”, “UserService”)

§qualified_name: Option<String>

Fully qualified name (e.g., “src/main.rs::main”)

§kind: SymbolKind

Symbol kind

§start_line: usize

Start line (1-indexed)

§end_line: usize

End line (1-indexed)

§start_col: usize

Start column (0-indexed)

§end_col: usize

End column (0-indexed)

§signature: Option<String>

Function/method signature (for display)

§visibility: Visibility

Visibility modifier

§doc_comment: Option<String>

Doc comment (if present)

§parent: Option<String>

Parent symbol name (for nested symbols)

§type_info: Option<String>

Type information (return type or declared type)

§parameters: Vec<Parameter>

Function/method parameters

§return_type: Option<String>

Return type (if available)

§exported: bool

Is this exported/public?

§is_async: bool

Is this async?

§is_static: bool

Is this static?

§generics: Vec<String>

Generic type parameters

§definition_start_line: Option<usize>

Line where annotation should be inserted (1-indexed) For decorated/attributed symbols, this is BEFORE the decorators/attributes For plain symbols, this equals start_line

Implementations§

Source§

impl ExtractedSymbol

Source

pub fn new( name: String, kind: SymbolKind, start_line: usize, end_line: usize, ) -> Self

Create a new ExtractedSymbol with required fields

Source

pub fn with_qualified_name(self, name: impl Into<String>) -> Self

Set the qualified name

Source

pub fn with_columns(self, start_col: usize, end_col: usize) -> Self

Set column positions

Source

pub fn with_signature(self, sig: impl Into<String>) -> Self

Set the signature

Source

pub fn with_visibility(self, vis: Visibility) -> Self

Set visibility

Source

pub fn with_doc_comment(self, doc: impl Into<String>) -> Self

Set doc comment

Source

pub fn with_parent(self, parent: impl Into<String>) -> Self

Set parent

Source

pub fn with_return_type(self, ret: impl Into<String>) -> Self

Set return type

Source

pub fn exported(self) -> Self

Mark as exported

Source

pub fn async_fn(self) -> Self

Mark as async

Source

pub fn static_fn(self) -> Self

Mark as static

Source

pub fn add_parameter(&mut self, param: Parameter)

Add a parameter

Source

pub fn add_generic(&mut self, generic: impl Into<String>)

Add a generic type parameter

Source

pub fn with_definition_start_line(self, line: usize) -> Self

Set the definition start line (where annotation should be inserted) This should be before any decorators/attributes

Trait Implementations§

Source§

impl Clone for ExtractedSymbol

Source§

fn clone(&self) -> ExtractedSymbol

Returns a duplicate 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 Debug for ExtractedSymbol

Source§

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

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

impl<'de> Deserialize<'de> for ExtractedSymbol

Source§

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

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

impl Serialize for ExtractedSymbol

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

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