Struct MarkdownLine

Source

pub struct MarkdownLine {
    pub line: usize,
    pub text: String,
    pub leading_prose: bool,
}

Expand description

One line of doc text that roxygen2 reads as markdown.

Fields§

§line: usize

1-based source line.

§text: String

The text, with the @tag name prefix removed on a tag’s first line.

§leading_prose: bool

Whether the line is leading prose (before the first @tag).

Trait Implementations§

Source §

impl Clone for MarkdownLine

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 MarkdownLine

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Eq for MarkdownLine

Source §

#[doc(hidden)]
fn assert_fields_are_eq(&self)

🔬This is a nightly-only experimental API. (derive_eq_internals)

1.0.0 (const: unstable) · Source§

#[doc(hidden)]
fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

Source §

impl PartialEq for MarkdownLine

Source §

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for MarkdownLine

Auto Trait Implementations§

§

impl RefUnwindSafe for MarkdownLine

§

impl UnsafeUnpin for MarkdownLine

§

impl UnwindSafe for MarkdownLine

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

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> SizeHint for T
where T: ?Sized,

Source §

default fn lower_bound(&self) -> usize

🔬This is a nightly-only experimental API. (core_io_internals)

Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more

Source §

default fn upper_bound(&self) -> Option<usize>

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more

Source §

final fn size_hint(&self) -> (usize, Option<usize>)

🔬This is a nightly-only experimental API. (core_io_internals)

Returns an estimate for the number of elements this container like type contains. Read more

Source §