Enum rustdoc::clean::cfg::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: &NestedMetaItem,
exclude: &FxHashSet<Cfg>
) -> Result<Option<Cfg>, InvalidCfgError>

Parses a NestedMetaItem into a Cfg.

source

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

source

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.

source

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.

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

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<Cfg> for Cfg

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<Cfg> for Cfg

source

fn bitand_assign(&mut self, other: Cfg)

Performs the &= operation. Read more

source

impl BitOr<Cfg> for Cfg

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<Cfg> 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,

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

source

impl Not for Cfg

type Output = Cfg

The resulting type after applying the ! operator.

source

fn not(self) -> Cfg

Performs the unary ! operation. Read more

source

impl PartialEq<Cfg> for Cfg

source

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

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

source

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

This method tests for !=.

source

impl Eq for Cfg

source

impl StructuralPartialEq for Cfg

Auto Trait Implementations

impl Send for Cfg

impl Sync for Cfg

impl Unpin for Cfg

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

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

source

impl<'a, T> Captures<'a> for T where
T: ?Sized,

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

Enum rustdoc::clean::cfg::Cfg

Variants

True

False

Cfg(Symbol, Option<Symbol>)

Not(Box<Cfg>)

Any(Vec<Cfg>)

All(Vec<Cfg>)

Implementations

impl Cfg

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

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

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

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

fn is_simple(&self) -> bool

fn is_all(&self) -> bool

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

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

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

fn should_capitalize_first_letter(&self) -> bool

fn should_append_only_to_description(&self) -> bool

fn should_use_with_in_description(&self) -> bool

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

Trait Implementations

impl BitAnd<Cfg> for Cfg

type Output = Cfg

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

impl BitAndAssign<Cfg> for Cfg

fn bitand_assign(&mut self, other: Cfg)

impl BitOr<Cfg> for Cfg

type Output = Cfg

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

impl BitOrAssign<Cfg> for Cfg

fn bitor_assign(&mut self, other: Cfg)

impl Clone for Cfg

fn clone(&self) -> Cfg

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

impl Debug for Cfg

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

impl Hash for Cfg

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

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

impl Not for Cfg

type Output = Cfg

fn not(self) -> Cfg

impl PartialEq<Cfg> for Cfg

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

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

impl Eq for Cfg

impl StructuralEq for Cfg

impl StructuralPartialEq for Cfg

Auto Trait Implementations

impl RefUnwindSafe for Cfg

impl Send for Cfg

impl Sync for Cfg

impl Unpin for Cfg

impl UnwindSafe for Cfg

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

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

type Owned = T

`True`

`False`

`Cfg(Symbol, Option<Symbol>)`

`Not(Box<Cfg>)`

`Any(Vec<Cfg>)`

`All(Vec<Cfg>)`

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

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

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

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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

impl<'a, T> Captures<'a> for T where
T: ?Sized,