Struct MaterialMechanics

pub struct MaterialMechanics { /* private fields */ }

Represents the mechanical properties of a material Represents the specific yield, fracture, and elasticity of a material for the various types of mechanical stress.

Implementations

impl Mechanics

pub fn new() -> Self

Creates a new Mechanics struct with default values.

Returns

• The new Mechanics struct.

pub const fn is_empty(&self) -> bool

Returns whether the Mechanics struct is empty.

Returns

• true if the Mechanics struct is empty, false otherwise.

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

Parses a tag and value into the Mechanics struct.

Arguments

• key - The tag to parse.
• value - The value to parse.

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.

Trait Implementations

impl Clone for Mechanics

fn clone(&self) -> Mechanics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mechanics

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

Formats the value using the given formatter.

impl Default for Mechanics

fn default() -> Mechanics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Mechanics

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl NamedType for Mechanics

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 Mechanics

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 Mechanics

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 Mechanics