Enum CmakeRole 

pub enum CmakeRole {
    Command,
    CpackGen,
    Envvar,
    Generator,
    Genex,
    Guide,
    Manual,
    Module,
    Policy,
    PropCache,
    PropDir,
    PropGbl,
    PropInst,
    PropSf,
    PropTest,
    PropTgt,
    Variable,
}

The various known domains and roles used in sphinx inventory files

Variants

Command

A cmake command in a cmake file like set() or add_executable() not to be confused with a command line command like cmake build see the cmake docs for more info

CpackGen

Cpack generators create packages out of artifacts such as installers see more

Envvar

A environment variable that cmake can use, e.g. CMAKE_CONFIG_DIR see more for more

Generator

A cmake Generator is responsible for writing the input files for a native build system. see more

Genex

A cmake generator expression see more

Guide

refers to a gide page such as the tutorial in the documentation

Manual

Refers to a man page such as cmake(1)

Module

A cmake module designed for reuse. see more

Policy

policies introduce behavior changes while preserving compatibility for existing project releases. see more

PropCache

A cache property see more

PropDir

A directory property see more

PropGbl

A global cmake property see more

PropInst

Properties on installed files see more

PropSf

Properties on source files see more

PropTest

Properties on tests see more

PropTgt

A target property see more

Variable

A cmake variable. can be set by cmake itself or by project code see more

Trait Implementations

impl Clone for CmakeRole

fn clone(&self) -> CmakeRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CmakeRole

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

Formats the value using the given formatter.

impl Display for CmakeRole

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

Formats the value using the given formatter.

impl FromStr for CmakeRole

type Err = ContextError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for CmakeRole

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CmakeRole