Skip to main content

EnumRepr

Enum EnumRepr 

Source
#[non_exhaustive]
pub enum EnumRepr { Flattened, ExternallyTagged, InternallyTagged { tag: &'static str, }, AdjacentlyTagged { tag: &'static str, content: &'static str, }, }
Expand description

How enum variants are represented in the serialized format.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Flattened

Variant fields are flattened to the same level as other fields. Also used for #[facet(untagged)] enums where there’s no tag at all. Used by formats like TOML where all fields appear at one level. Example: {"name": "...", "host": "...", "port": 8080}

§

ExternallyTagged

Variant name is a key, variant content is nested under it. This is the default serde representation for enums. Example: {"name": "...", "Tcp": {"host": "...", "port": 8080}}

§

InternallyTagged

Tag field is inside the content, alongside variant fields. Used with #[facet(tag = "type")]. Example: {"type": "Tcp", "host": "...", "port": 8080}

Fields

§tag: &'static str

The name of the tag field (e.g., “type”)

§

AdjacentlyTagged

Tag and content are adjacent fields at the same level. Used with #[facet(tag = "t", content = "c")]. Example: {"t": "Tcp", "c": {"host": "...", "port": 8080}}

Fields

§tag: &'static str

The name of the tag field (e.g., “t”)

§content: &'static str

The name of the content field (e.g., “c”)

Implementations§

Source§

impl EnumRepr

Source

pub const fn from_shape(shape: &'static Shape) -> Self

Detect the enum representation from a Shape’s attributes.

Returns:

  • Flattened if #[facet(untagged)]
  • InternallyTagged if #[facet(tag = "...")] without content
  • AdjacentlyTagged if both #[facet(tag = "...", content = "...")]
  • ExternallyTagged if no attributes (the default enum representation)

Trait Implementations§

Source§

impl Clone for EnumRepr

Source§

fn clone(&self) -> EnumRepr

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnumRepr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for EnumRepr

Source§

fn default() -> EnumRepr

Returns the “default value” for a type. Read more
Source§

impl Eq for EnumRepr

Source§

impl PartialEq for EnumRepr

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for EnumRepr

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.