Skip to content

Documentation for VariantArray and VariantNames say their VARIANTS constants are arrays, but they're actually slices #335

New issue
New issue
Closed
#343
Closed
Documentation for VariantArray and VariantNames say their VARIANTS constants are arrays, but they're actually slices#335
#343
@IndigoLily

Description

@IndigoLily
IndigoLily
opened on Feb 22, 2024

The incorrect documentation:

strum/strum_macros/src/lib.rs

Line 169 in 2056939

/// Implements `Strum::VariantNames` which adds an associated constant `VARIANTS` which is an array of discriminant names.

strum/strum_macros/src/lib.rs

Line 215 in 2056939

/// Adds a static array with all of the Enum's variants.

strum/strum/src/lib.rs

Line 220 in 2056939

/// A trait for retrieving a static array containing all the variants in an Enum.

The actual types:

strum/strum/src/lib.rs

Line 217 in 2056939

const VARIANTS: &'static [&'static str];

strum/strum/src/lib.rs

Line 227 in 2056939

const VARIANTS: &'static [Self];

I personally think these constants should be actual arrays (because it's much easier to get a slice from an array than vice versa), but I'm not sure how feasible that is in current stable Rust.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions