Skip to main content

GetItemData

Struct GetItemData 

Source
pub struct GetItemData {
Show 15 fields pub crate_name: String, pub item_type: String, pub item_path: String, pub item_name: String, pub version: String, pub resolved_version: Option<String>, pub markdown: String, pub empty: bool, pub truncated: bool, pub source_url: String, pub title: String, pub cache_hit: bool, pub extraction: Option<String>, pub anchor_family: Option<String>, pub resolved_item_path: Option<String>,
}
Expand description

Typed item documentation payload.

Fields§

§crate_name: String

Requested crate name.

§item_type: String

Normalized item kind string.

§item_path: String

Requested item path.

§item_name: String

Last path segment (leaf name) for agent convenience.

§version: String

Requested version token.

§resolved_version: Option<String>

Version resolved by docs.rs redirects when known.

§markdown: String

Markdown extracted from the item page.

§empty: bool

True when the item body is empty.

§truncated: bool

True when output was truncated by max_output_bytes.

§source_url: String

Final source URL of the HTML page.

§title: String

Page title when available.

§cache_hit: bool

True when the HTTP body was served from the local disk cache.

§extraction: Option<String>

How markdown was scoped for associated methods. Success path is method only (1.2.0+ fail-closed; missing anchors are errors).

Read this as “the markdown came from the member anchor”, never as “the member is a function”. It reports method for every anchor family, including variant. and structfield., which is why Self::anchor_family exists.

§anchor_family: Option<String>

Rustdoc anchor family the markdown was actually scoped to.

One of method, tymethod, associatedtype, associatedconstant, variant or structfield, derived from the anchor id that matched on the page rather than from the requested kind.

Added instead of correcting Self::extraction because agents already assert extraction == "method" to reject a parent-page false success (see src/docs_rs/html/extract.rs); changing that value would break them silently, while an absent field is a shape every reader already handles.

§resolved_item_path: Option<String>

Canonical rustdoc path when a reexport/root path was resolved via all.html.

Trait Implementations§

Source§

impl Clone for GetItemData

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 GetItemData

Source§

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

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

impl<'de> Deserialize<'de> for GetItemData

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 GetItemData

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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 = !

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