Enum const_panic::fmt::Delimiter

#[non_exhaustive]
pub enum Delimiter {
    OpenParen,
    CloseParen,
    OpenBracket,
    CloseBracket,
    OpenBrace,
    CloseBrace,
    Empty,
}

This is supported on crate feature non_basic only.

For outputting an alternate flag-aware delimiter.

This was created for formatting structs and enum variants, so these delimiters have spaces around them to follow the
Foo { bar: baz }, Foo(bar), and [foo, bar] style.

Example

use const_panic::{
    fmt::{self, FmtArg},
    ArrayString,
    flatten_panicvals,
};

// Debug formatting
assert_eq!(
    ArrayString::<999>::from_panicvals(
        &flatten_panicvals!(FmtArg::DEBUG;
            open: fmt::EmptyDelimiter,
                100u8, fmt::COMMA_SEP,
                false, fmt::COMMA_SEP,
                [0u16; 0], fmt::COMMA_SEP,
                // parenthesizing to pass this as a non-literal
                // otherwise the string is Display formatted
                ("really"), fmt::COMMA_TERM,
            close: "",
        )
    ).unwrap(),
    " 100, false, [], \"really\""
);


// Alternate-Debug formatting
assert_eq!(
    ArrayString::<999>::from_panicvals(
        &flatten_panicvals!(FmtArg::ALT_DEBUG;
            open: fmt::EmptyDelimiter,
                100u8, fmt::COMMA_SEP,
                false, fmt::COMMA_SEP,
                [0u16; 0], fmt::COMMA_SEP,
                ("really"), fmt::COMMA_TERM,
            close: "",
        )
    ).unwrap(),
    concat!(
        "\n",
        "    100,\n",
        "    false,\n",
        "    [],\n",
        "    \"really\",\n",
    )
);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OpenParen

(

CloseParen

)

OpenBracket

[

CloseBracket

]

OpenBrace

{

CloseBrace

}

Empty

An empty delimiter, exists only to add whitespace on the next line when the alternate flag is enabled.

Implementations

impl Delimiter

pub const fn to_panicvals(self, f: FmtArg) -> [PanicVal<'static>; 1]

Converts this Delimiter into an array of one PanicVal

When the alternate flag is enabled, this and the to_panicval method output:

• the delimiter
• a newline
• fmtarg.indentation amount of spaces

When the alternate flag is disabled, these methods output braces with spaces around them, the empty delimiter as one space, and the remaining delimiters with no spaces around them.

pub const fn to_panicval(self, f: FmtArg) -> PanicVal<'static>

Converts this Delimiter into a PanicVal

Trait Implementations

impl Clone for Delimiter

fn clone(&self) -> Delimiter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PanicFmt for Delimiter

type This = Self

The type after dereferencing all references.

type Kind = IsCustomType

Whether this is a user-defined type or standard library type.

const PV_COUNT: usize

The length of the array returned in Self::to_panicvals (an inherent method that formats the type for panic messages).

const PROOF: IsPanicFmt<Self, Self::This, Self::Kind>

A marker type that proves that Self implements PanicFmt.

impl PartialEq<Delimiter> for Delimiter

fn eq(&self, other: &Delimiter) -> 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 !=.

impl Copy for Delimiter

impl Eq for Delimiter

impl StructuralEq for Delimiter

impl StructuralPartialEq for Delimiter