Struct fj::models::ModelMetadata

pub struct ModelMetadata {
    pub name: String,
    pub description: Option<String>,
    pub arguments: Vec<ArgumentMetadata>,
}

Metadata about a crate::models::Model.

Fields

name: String

A short, human-friendly name used to identify this model.

description: Option<String>

A description of what this model does.

arguments: Vec<ArgumentMetadata>

Arguments that the model uses when calculating its geometry.

Implementations

impl ModelMetadata

pub fn new(name: impl Into<String>) -> Self

Create metadata for a model.

Panics

The name must not be empty.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the ModelMetadata::description.

pub fn with_argument(self, arg: impl Into<ArgumentMetadata>) -> Self

Add an argument to the ModelMetadata::arguments list.

As a convenience, string literals can be automatically converted into ArgumentMetadata with no description or default value.

Trait Implementations

impl Clone for ModelMetadata

fn clone(&self) -> ModelMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModelMetadata

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

Formats the value using the given formatter.

impl PartialEq<ModelMetadata> for ModelMetadata

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

This method tests for self and other values to be equal, and is used by ==.

const 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 Eq for ModelMetadata

impl StructuralEq for ModelMetadata

impl StructuralPartialEq for ModelMetadata