Struct SingPlurName 

pub struct SingPlurName { /* private fields */ }

The name of a raw object with only singular and plural forms

Implementations

impl Name

pub fn from_value(value: &str) -> Self

Takes the arguments for a name and split ‘:’ into sing, plural

Arguments

• value - The value to parse into a Name struct (e.g. singular:plural)

Returns

• The Name struct

pub fn is_empty(&self) -> bool

Returns whether the name is empty

Returns

• true if the name is empty, false otherwise.

pub fn as_vec(&self) -> Vec<String>

Returns the name as a vector of strings

Returns

• Vec<String> - The name as a vector of strings

pub fn new(name_singular: &str, name_plural: &str) -> Self

Create a new SingularPluralName instance.

Arguments

• name_singular - The singular name.
• name_plural - The plural name.

Returns

A new SingularPluralName instance.

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Name

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

Formats the value using the given formatter.

impl Default for Name

fn default() -> Name

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Name

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for Name

fn named_data_type( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<NamedDataType, ExportError>

this is equivalent to Type::inline but returns a NamedDataType instead. This is a compile-time guaranteed alternative to extracting the DataType::Named variant.

fn definition_named_data_type( opts: DefOpts<'_>, ) -> Result<NamedDataType, ExportError>

this is equivalent to Type::definition but returns a NamedDataType instead. This is a compile-time guaranteed alternative to extracting the DataType::Named variant.

impl Serialize for Name

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for Name

fn inline( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<DataType, ExportError>

Returns the inline definition of a type with generics substituted for those provided. This function defines the base structure of every type, and is used in both definition and reference

fn category_impl( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<TypeCategory, ExportError>

Defines which category this type falls into, determining how references to it are created. See TypeCategory for more info.

fn definition_generics() -> Vec<GenericType>

Returns the type parameter generics of a given type. Will usually be empty except for custom types.

fn definition(opts: DefOpts<'_>) -> Result<DataType, ExportError>

Small wrapper around inline that provides definition_generics as the value for the generics arg.

fn reference( opts: DefOpts<'_>, generics: &[DataType], ) -> Result<DataType, ExportError>

Generates a datatype corresponding to a reference to this type, as determined by its category. Getting a reference to a type implies that it should belong in the type map (since it has to be referenced from somewhere), so the output of definition will be put into the type map.

impl Flatten for Name