rustdoc::clean::cfg

Enum Cfg

source
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§

source§

impl Cfg

source

fn parse_nested( nested_cfg: &MetaItemInner, exclude: &FxHashSet<Cfg>, ) -> Result<Option<Cfg>, InvalidCfgError>

Parses a MetaItemInner into a Cfg.

source

pub(crate) fn parse_without( cfg: &MetaItem, exclude: &FxHashSet<Cfg>, ) -> Result<Option<Cfg>, InvalidCfgError>

source

pub(crate) fn parse(cfg: &MetaItemInner) -> 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.

source

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

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

Equivalent to attr::cfg_matches.

source

fn is_simple(&self) -> bool

Whether the configuration consists of just Cfg or Not.

source

fn is_all(&self) -> bool

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

source

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

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

source

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

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

source

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

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

source

fn should_capitalize_first_letter(&self) -> bool

source

fn should_append_only_to_description(&self) -> bool

source

fn should_use_with_in_description(&self) -> bool

source

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§

source§

impl BitAnd for Cfg

source§

type Output = Cfg

The resulting type after applying the & operator.
source§

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

Performs the & operation. Read more
source§

impl BitAndAssign for Cfg

source§

fn bitand_assign(&mut self, other: Cfg)

Performs the &= operation. Read more
source§

impl BitOr for Cfg

source§

type Output = Cfg

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl BitOrAssign for Cfg

source§

fn bitor_assign(&mut self, other: Cfg)

Performs the |= operation. Read more
source§

impl Clone for Cfg

source§

fn clone(&self) -> Cfg

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Cfg

source§

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

Formats the value using the given formatter. Read more
source§

impl Hash for Cfg

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Not for Cfg

source§

type Output = Cfg

The resulting type after applying the ! operator.
source§

fn not(self) -> Cfg

Performs the unary ! operation. Read more
source§

impl PartialEq for Cfg

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Eq for Cfg

source§

impl StructuralPartialEq for Cfg

Auto Trait Implementations§

§

impl Freeze for Cfg

§

impl RefUnwindSafe for Cfg

§

impl Send for Cfg

§

impl Sync for Cfg

§

impl Unpin for Cfg

§

impl UnwindSafe for Cfg

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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: 32 bytes

Size for each variant:

  • True: 0 bytes
  • False: 0 bytes
  • Cfg: 8 bytes
  • Not: 12 bytes
  • Any: 28 bytes
  • All: 28 bytes