Enum rustdoc::clean::cfg::Cfg

pub(crate) enum Cfg {
    True,
    False,
    Cfg(Symbol, Option<Symbol>),
    Not(Box<Cfg>),
    Any(Vec<Cfg>),
    All(Vec<Cfg>),
}

Variants

True

Accepts all configurations.

False

Denies all configurations.

Cfg(Symbol, Option<Symbol>)

A generic configuration option, e.g., test or target_os = "linux".

Not(Box<Cfg>)

Negates a configuration requirement, i.e., not(x).

Any(Vec<Cfg>)

Union of a list of configuration requirements, i.e., any(...).

All(Vec<Cfg>)

Intersection of a list of configuration requirements, i.e., all(...).

Implementations

impl Cfg

pub(in clean::cfg) fn parse_nested(
    nested_cfg: &NestedMetaItem
) -> Result<Cfg, InvalidCfgError>

Parses a NestedMetaItem into a Cfg.

pub(crate) fn parse(cfg: &MetaItem) -> Result<Cfg, InvalidCfgError>

Parses a MetaItem into a Cfg.

The MetaItem should be the content of the #[cfg(...)], e.g., unix or target_os = "redox".

If the content is not properly formatted, it will return an error indicating what and where the error is.

pub(crate) fn matches(
    &self,
    parse_sess: &ParseSess,
    features: Option<&Features>
) -> bool

Checks whether the given configuration can be matched in the current session.

Equivalent to attr::cfg_matches.

pub(in clean::cfg) fn is_simple(
    &self
) -> bool

Whether the configuration consists of just Cfg or Not.

pub(in clean::cfg) fn is_all(
    &self
) -> bool

Whether the configuration consists of just Cfg, Not or All.

pub(crate) fn render_short_html(&self) -> String

Renders the configuration for human display, as a short HTML description.

pub(crate) fn render_long_html(&self) -> String

Renders the configuration for long display, as a long HTML description.

pub(crate) fn render_long_plain(&self) -> String

Renders the configuration for long display, as a long plain text description.

pub(in clean::cfg) fn should_capitalize_first_letter(
    &self
) -> bool

pub(in clean::cfg) fn should_append_only_to_description(
    &self
) -> bool

pub(in clean::cfg) fn should_use_with_in_description(
    &self
) -> bool

pub(crate) fn simplify_with(&self, assume: &Cfg) -> Option<Cfg>

Attempt to simplify this cfg by assuming that assume is already known to be true, will return None if simplification managed to completely eliminate any requirements from this Cfg.

See tests::test_simplify_with for examples.

Trait Implementations

impl BitAnd<Cfg> for Cfg

type Output = Cfg

The resulting type after applying the & operator.

pub fn bitand(self, other: Cfg) -> Cfg

Performs the & operation.

impl BitAndAssign<Cfg> for Cfg

pub fn bitand_assign(&mut self, other: Cfg)

Performs the &= operation.

impl BitOr<Cfg> for Cfg

type Output = Cfg

The resulting type after applying the | operator.

pub fn bitor(self, other: Cfg) -> Cfg

Performs the | operation.

impl BitOrAssign<Cfg> for Cfg

pub fn bitor_assign(&mut self, other: Cfg)

Performs the |= operation.

impl Clone for Cfg

pub fn clone(&self) -> Cfg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cfg

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

Formats the value using the given formatter.

impl Eq for Cfg

impl Hash for Cfg

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Not for Cfg

type Output = Cfg

The resulting type after applying the ! operator.

pub fn not(self) -> Cfg

Performs the unary ! operation.

impl PartialEq<Cfg> for Cfg

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Cfg

impl StructuralPartialEq for Cfg