Struct IncludeGuard

pub struct IncludeGuard {
    pub scope: Option<Scope>,
}

Provides an include guard for the file currently being processed by CMake.

Reference: https://cmake.org/cmake/help/v3.26/command/include_guard.html

Fields

scope: Option<Scope>

Trait Implementations

impl<'t> CMakeParse<'t> for IncludeGuard

fn parse<'tv>( tokens: &'tv [Token<'t>], ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn complete(tokens: &[Token<'t>]) -> Result<Self, CommandParseError>

fn default_value() -> Option<Self>

fn matches( &self, field_keyword: &[u8], keyword: &[u8], tokens: &[Token<'t>], ) -> bool

fn matches_type( field_keyword: &[u8], keyword: &[u8], tokens: &[Token<'t>], ) -> bool

fn need_update( field_keyword: &[u8], keyword: &Token<'t>, buffer: &[Token<'t>], ) -> bool

fn start<'tv>( &mut self, field_keyword: &[u8], keyword: &Token<'t>, tokens: &'tv [Token<'t>], buffer: &mut Vec<Token<'t>>, ) -> Result<(bool, &'tv [Token<'t>]), CommandParseError>

fn rest<'tv>(tokens: &'tv [Token<'t>]) -> &'tv [Token<'t>]

fn need_push_keyword(keyword: &Token<'t>) -> bool

fn update_mode(keyword: &Token<'t>) -> bool

fn update<'tv>( &mut self, tokens: &'tv [Token<'t>], ) -> Result<(), CommandParseError>

fn end<'tv>(self, tokens: &'tv [Token<'t>]) -> Result<Self, CommandParseError>

fn push_keyword( &mut self, buffer: &mut Vec<Token<'t>>, keyword: &Token<'t>, ) -> bool

fn reset_mode() -> bool

impl<'t> CMakePositional<'t> for IncludeGuard

fn positional<'tv>( default_name: &'static [u8], tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn positional_complete<'tv>( default_name: &'static [u8], tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

fn in_range<'tv>( default_name: &'static [u8], to: &'static [u8], allow_empty: bool, tokens: &'tv [Token<'t>], has_keyword: bool, ) -> Result<(Self, &'tv [Token<'t>]), CommandParseError>

impl Clone for IncludeGuard

fn clone(&self) -> IncludeGuard

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IncludeGuard

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

Formats the value using the given formatter.

impl Hash for IncludeGuard

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 Ord for IncludeGuard

fn cmp(&self, other: &IncludeGuard) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for IncludeGuard

fn eq(&self, other: &IncludeGuard) -> 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 PartialOrd for IncludeGuard

fn partial_cmp(&self, other: &IncludeGuard) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl ToCommandScope for IncludeGuard

fn to_command_scope(&self) -> CommandScope

impl Eq for IncludeGuard

impl StructuralPartialEq for IncludeGuard