Skip to main content

SurfaceEntry

Struct SurfaceEntry 

Source
pub struct SurfaceEntry {
    pub path: String,
    pub kind: String,
    pub signature: String,
    pub pkg: String,
    pub summary: String,
    pub docs: String,
}
Expand description

One public item as fed by the CLI (from the docs-engine surface).

Fields§

§path: String§kind: String§signature: String§pkg: String

Name of the crate this item was extracted from (groups multi-crate digests; report.rs concatenates one surface_entries() call per -p PKG flag into a single entry list).

§summary: String

First line of the doc comment — compact, for search hits and lists.

§docs: String

Full doc comment (all paragraphs, code fences intact) — the whole point of llms.txt over a bare signature list: an agent gets the actual usage explanation, not just a name to guess at.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.