pub struct DocAssociation {
pub name: String,
pub kind: DocKind,
pub range: TextRange,
pub name_range: TextRange,
pub code: Vec<TextRange>,
}Expand description
One documented entity: the documenting construct, the name it documents, and any code it brackets.
Fields§
§name: StringThe documented name: \foo (backslash kept) for a macro, tabular for an
environment.
kind: DocKind§range: TextRangeThe full extent of the documenting construct.
name_range: TextRangeThe name-argument sub-range to highlight on selection (always ⊆ range).
code: Vec<TextRange>Ranges of the macrocode/macrocode* blocks nested inside the construct —
the implementation it documents. Empty for \DescribeMacro/\DescribeEnv
and for a prose-only macro/environment environment.
Trait Implementations§
Source§impl Clone for DocAssociation
impl Clone for DocAssociation
Source§fn clone(&self) -> DocAssociation
fn clone(&self) -> DocAssociation
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DocAssociation
impl Debug for DocAssociation
impl Eq for DocAssociation
Source§impl PartialEq for DocAssociation
impl PartialEq for DocAssociation
impl StructuralPartialEq for DocAssociation
Auto Trait Implementations§
impl Freeze for DocAssociation
impl RefUnwindSafe for DocAssociation
impl Send for DocAssociation
impl Sync for DocAssociation
impl Unpin for DocAssociation
impl UnsafeUnpin for DocAssociation
impl UnwindSafe for DocAssociation
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