Enum FieldKey 

pub enum FieldKey<'de> {
    Name(Cow<'de, str>),
    Full(Box<FullFieldKey<'de>>),
}

Field key for a serialized field.

This enum is optimized for the common case (simple named keys) while still supporting rich metadata for formats like Styx.

• Name: Simple string key (24 bytes) - used by JSON, YAML, TOML, etc.
• Full: Boxed full key with metadata (8 bytes) - used by Styx for doc/tag support.

Variants

Name(Cow<'de, str>)

Simple named key (common case for JSON/YAML/TOML).

Full(Box<FullFieldKey<'de>>)

Full key with metadata support (for Styx).

Implementations

impl<'de> FieldKey<'de>

pub fn new(name: impl Into<Cow<'de, str>>, _location: FieldLocationHint) -> Self

Create a new field key with a name (common case).

pub fn with_doc( name: impl Into<Cow<'de, str>>, location: FieldLocationHint, doc: Vec<Cow<'de, str>>, ) -> Self

Create a new field key with a name and documentation.

pub fn tagged( tag: impl Into<Cow<'de, str>>, location: FieldLocationHint, ) -> Self

Create a tagged field key (e.g., @string in Styx).

Used for type pattern keys where the key is a tag rather than a bare identifier.

pub fn tagged_with_doc( tag: impl Into<Cow<'de, str>>, location: FieldLocationHint, doc: Vec<Cow<'de, str>>, ) -> Self

Create a tagged field key with documentation.

pub fn tagged_with_name( tag: impl Into<Cow<'de, str>>, name: impl Into<Cow<'de, str>>, location: FieldLocationHint, ) -> Self

Create a tagged field key with a name (e.g., @string"mykey" in Styx).

Used for type pattern keys that also have an associated name/payload.

pub fn tagged_with_name_and_doc( tag: impl Into<Cow<'de, str>>, name: impl Into<Cow<'de, str>>, location: FieldLocationHint, doc: Vec<Cow<'de, str>>, ) -> Self

Create a tagged field key with a name and documentation.

pub fn unit(location: FieldLocationHint) -> Self

Create a unit field key (no name).

Used for formats like Styx where @ represents a unit key in maps. This is equivalent to tagged("") - a tag with an empty name.

pub fn unit_with_doc( location: FieldLocationHint, doc: Vec<Cow<'de, str>>, ) -> Self

Create a unit field key with documentation.

pub fn name(&self) -> Option<&Cow<'de, str>>

Get the field name, if any.

pub fn doc(&self) -> Option<&[Cow<'de, str>]>

Get the documentation comments, if any.

pub fn tag(&self) -> Option<&Cow<'de, str>>

Get the tag name, if any.

pub fn meta(&self) -> Option<&ValueMeta<'de>>

Get the metadata, if any.

pub fn location(&self) -> FieldLocationHint

Get the location hint.

Trait Implementations

impl<'de> Clone for FieldKey<'de>

fn clone(&self) -> FieldKey<'de>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Debug for FieldKey<'de>

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

Formats the value using the given formatter.

impl<'de> PartialEq for FieldKey<'de>

fn eq(&self, other: &FieldKey<'de>) -> 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<'de> Eq for FieldKey<'de>

impl<'de> StructuralPartialEq for FieldKey<'de>