Struct vtubestudio::data::EnumString

pub struct EnumString<T>(_);

Wrapper type for an enum with a serialized string representation.

This allows for defining an enum with a set of known values, but still accept other arbitrary string values when serializing/deserializing.

Example

use vtubestudio::data::{EnumString, ResponseType};

// Multiple representations of the same enum
let resp_enum = EnumString::new(ResponseType::VtsFolderInfoResponse);
let resp_str = EnumString::new_from_str("VTSFolderInfoResponse");

// Can be compared to the inner enum type and other `EnumString`s
assert_eq!(resp_enum, ResponseType::VtsFolderInfoResponse);
assert_eq!(resp_str, ResponseType::VtsFolderInfoResponse);
assert_eq!(resp_enum, resp_str);

// Get the string representation of the enum
assert_eq!(resp_enum.as_str(), "VTSFolderInfoResponse");
assert_eq!(resp_str.as_str(), "VTSFolderInfoResponse");

Implementations

impl EnumString<ResponseType>

pub fn is_event(&self) -> bool

Whether this response type is an event.

More specifically, it returns true if the underlying event type enum is a known Event type, or if the string ends with "Event".

impl<T> EnumString<T>

pub const fn new(variant: T) -> Self

Creates a new value from a known variant.

pub fn new_from_str<S>(value: S) -> Selfwhere
    S: Into<Cow<'static, str>>,

Creates a new value from a raw string.

pub const fn const_new_from_str(value: &'static str) -> Self

Creates a new value from a const static string slice.

impl<T> EnumString<T>where
    T: Serialize,

pub fn as_str(&self) -> &str

Returns the string representation.

Trait Implementations

impl<T: Clone> Clone for EnumString<T>

fn clone(&self) -> EnumString<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for EnumString<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for EnumString<T>

fn default() -> EnumString<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for EnumString<T>where
    T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for EnumString<T>where
    T: Serialize,

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

Formats the value using the given formatter.

impl<T> From<T> for EnumString<T>where
    T: Serialize + PartialEq,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T> PartialEq<EnumString<T>> for EnumString<T>where
    T: Serialize + PartialEq,

fn eq(&self, rhs: &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<T> PartialEq<T> for EnumString<T>where
    T: Serialize + PartialEq,

fn eq(&self, rhs: &T) -> 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<T> Serialize for EnumString<T>where
    T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.