Enum RdPage 

pub(crate) enum RdPage {
    Rendered,
    Suppressed,
}

Whether a doc block’s roxygen text can reach a rendered help page, as far as the caller knows, which decides what happens to its [...] links.

A block that renders no page sends roxygen2 no link: none of them could render, and roxygen2 still resolves (and warns on) every one it is handed (#1818). The reader sees an explicit @noRd in the block itself; the caller says when its attributes take the page away.

Variants

Rendered

The block renders a page unless its own tags say @noRd: its links follow the crate’s ProseLinks setting.

Suppressed

The block renders no page whatever its tags: a noexport entry point, a class without a page, or a method of one. Every link loses its brackets (Neutralize::AllLinks).

Implementations

impl RdPage

pub(crate) fn suppressed_if(no_page: bool) -> Self

RdPage::Suppressed when no_page, else RdPage::Rendered.

Trait Implementations

impl Clone for RdPage

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RdPage

impl Debug for RdPage

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

Formats the value using the given formatter.

impl Eq for RdPage

#[doc(hidden)]

fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

#[doc(hidden)]

fn assert_fields_are_eq(&self)

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

impl PartialEq for RdPage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RdPage

impl TrivialClone for RdPage

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: 1 byte

Size for each variant:

• Rendered: 0 bytes
• Suppressed: 0 bytes