Enum LineRole

Source

enum LineRole {
    Prose,
    TagStart,
    TagBody,
    Rustdoc,
}

Expand description

What a doc line is to roxygen extraction and rustdoc stripping.

Variants§

§

Prose

Before the first tag: leading prose (promoted to @description, kept in rustdoc).

§

TagStart

A line starting with @ (after leading whitespace): a new tag.

§

TagBody

Part of the open tag’s text, or a blank line that ends a tag (trailing, or before the next tag).

§

Rustdoc

After a single-line tag: rustdoc only, never R. A blank line is rustdoc when a rustdoc-only line follows it.

Trait Implementations§

Source §

impl Clone for LineRole

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 LineRole

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Eq for LineRole

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 §

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

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

Source §

impl PartialEq for LineRole

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 LineRole

Source §

impl TrivialClone for LineRole

Auto Trait Implementations§

§

impl RefUnwindSafe for LineRole

§

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> Printable for T
where T: Copy + Debug,

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 §