Struct rustc_resolve::rustdoc::DocFragment
source · pub struct DocFragment {
pub span: Span,
pub item_id: Option<DefId>,
pub doc: Symbol,
pub kind: DocFragmentKind,
pub indent: usize,
}
Expand description
A portion of documentation, extracted from a #[doc]
attribute.
Each variant contains the line number within the complete doc-comment where the fragment starts, as well as the Span where the corresponding doc comment or attribute is located.
Included files are kept separate from inline doc comments so that proper line-number information can be given when a doctest fails. Sugared doc comments and “raw” doc comments are kept separate because of issue #42760.
Fields§
§span: Span
§item_id: Option<DefId>
The item this doc-comment came from. Used to determine the scope in which doc links in this fragment are resolved. Typically filled for reexport docs when they are merged into the docs of the original reexported item. If the id is not filled, which happens for the original reexported item, then it has to be taken from somewhere else during doc link resolution.
doc: Symbol
§kind: DocFragmentKind
§indent: usize
Trait Implementations§
source§impl Clone for DocFragment
impl Clone for DocFragment
source§fn clone(&self) -> DocFragment
fn clone(&self) -> DocFragment
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for DocFragment
impl Debug for DocFragment
source§impl PartialEq<DocFragment> for DocFragment
impl PartialEq<DocFragment> for DocFragment
source§fn eq(&self, other: &DocFragment) -> bool
fn eq(&self, other: &DocFragment) -> bool
self
and other
values to be equal, and is used
by ==
.impl Eq for DocFragment
impl StructuralEq for DocFragment
impl StructuralPartialEq for DocFragment
Auto Trait Implementations§
impl RefUnwindSafe for DocFragment
impl !Send for DocFragment
impl !Sync for DocFragment
impl Unpin for DocFragment
impl UnwindSafe for DocFragment
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
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 32 bytes