Enum ReferenceType

pub enum ReferenceType {
    Document,
    Section,
    Function,
    Class,
    Module,
    Method,
    Attribute,
    Data,
    Exception,
    Custom(String),
}

Represents the type of a cross-reference

Variants

Document

Document reference (:doc:)

Section

Section reference (:ref:)

Function

Function reference (:func:)

Class

Class reference (:class:)

Module

Module reference (:mod:)

Method

Method reference (:meth:)

Attribute

Attribute reference (:attr:)

Data

Data reference (:data:)

Exception

Exception reference (:exc:)

Custom(String)

Custom reference type

Trait Implementations

impl Clone for ReferenceType

fn clone(&self) -> ReferenceType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceType

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

Formats the value using the given formatter.

impl Display for ReferenceType

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

Formats the value using the given formatter.

impl Hash for ReferenceType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReferenceType

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ReferenceType

impl StructuralPartialEq for ReferenceType