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: StringName 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: StringFirst line of the doc comment — compact, for search hits and lists.
docs: StringFull 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§
impl Freeze for SurfaceEntry
impl RefUnwindSafe for SurfaceEntry
impl Send for SurfaceEntry
impl Sync for SurfaceEntry
impl Unpin for SurfaceEntry
impl UnsafeUnpin for SurfaceEntry
impl UnwindSafe for SurfaceEntry
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more