Struct deluxe_core::Flag

pub struct Flag(_);

A value for a boolean named field that can only be a name (set) or omitted (unset).

Similar to an Option<SpannedValue<bool>> but does not allow = or () after the field name. Thus, it is only useful with named fields. Parsing this out of a tuple struct or tuple variant will always result in a parse error.

It is not necessary to use #[deluxe(default)] on a field using this type. The field will automatically be created with a false value if the name is omitted.

Implementations

impl Flag

pub fn set(span: Span) -> Self

Creates a new true flag value spanned to span.

pub fn set_call_site() -> Self

Creates a new true flag value spanned to Span::call_site.

pub fn unset() -> Self

Creates a new false flag value.

pub fn is_set(&self) -> bool

Returns true if the flag was set.

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flag

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

Formats the value using the given formatter.

impl Default for Flag

fn default() -> Flag

Returns the “default value” for a type.

impl From<Flag> for bool

fn from(value: Flag) -> Self

Converts to this type from the input type.

impl From<bool> for Flag

fn from(value: bool) -> Self

Converts to this type from the input type.

impl ParseMetaItem for Flag

fn parse_meta_item(input: ParseStream<'_>, mode: ParseMode) -> Result<Self>

Parse the item from the tokens in input.

fn parse_meta_item_inline<'s, S: Borrow<ParseBuffer<'s>>>( inputs: &[S], _mode: ParseMode ) -> Result<Self>

Parse the item in an inline context.

fn parse_meta_item_flag(span: Span) -> Result<Self>

Parses an empty flag value.

fn parse_meta_item_named( input: ParseStream<'_>, _name: &str, span: Span ) -> Result<Self>

Parses the item following a name.

fn missing_meta_item(_name: &str, _span: Span) -> Result<Self>

Fallback for when a required item is missing.

impl PartialEq<Flag> for Flag

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Flag> for bool

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<bool> for Flag

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToTokens for Flag

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStreamwhere Self: Sized,

Convert self directly into a TokenStream object.

impl Copy for Flag

impl Eq for Flag