Struct SelectCreature 

pub struct SelectCreature { /* private fields */ }

A struct representing a creature selection

Implementations

impl SelectCreature

pub fn new(identifier: &str, metadata: &RawMetadata) -> Self

Create a new SelectCreature

Arguments

• identifier - The identifier of the creature
• metadata - The metadata of the creature

Returns

A new SelectCreature

pub fn empty() -> Self

Create a new empty SelectCreature

Returns

A new empty SelectCreature

pub fn cleaned(&self) -> Self

Function to “clean” the raw. This is used to remove any empty list or strings, and to remove any default values. By “removing” it means setting the value to None.

This also will remove the metadata if is_metadata_hidden is true.

Steps for all “Option” fields:

• Set any metadata to None if is_metadata_hidden is true.
• Set any empty string to None.
• Set any empty list to None.
• Set any default values to None.

Returns

A cleaned SelectCreature

Trait Implementations

impl Clone for SelectCreature

fn clone(&self) -> SelectCreature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectCreature

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

Formats the value using the given formatter.

impl Default for SelectCreature

fn default() -> SelectCreature

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SelectCreature

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for SelectCreature

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 RawObject for SelectCreature

fn get_metadata(&self) -> RawMetadata

Get the metadata for the raw.

fn clean_self(&mut self)

Function to “clean” the creature. This is used to remove any empty list or strings, and to remove any default values. By “removing” it means setting the value to None.

fn get_identifier(&self) -> &str

Get the identifier of the raw.

fn get_name(&self) -> &str

Get the name of the raw (if it has one). If no name is found, the identifier is returned instead. This is used for searching.

fn is_empty(&self) -> bool

Returns true if the raw is empty.

fn get_type(&self) -> &ObjectType

Get the type of the raw.

fn parse_tag(&mut self, key: &str, value: &str)

Parse a new tag from the raw file into this raw object.

fn get_object_id(&self) -> &str

Get the object ID of the raw.

impl Searchable for SelectCreature

fn get_search_vec(&self) -> Vec<String>

The get_search_vec function returns a vector of strings that can be used to search for an object.

impl Serialize for SelectCreature

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 SelectCreature

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 SelectCreature