Struct fj::models::ArgumentMetadata

pub struct ArgumentMetadata {
    pub name: String,
    pub description: Option<String>,
    pub default_value: Option<String>,
}

Metadata describing a model’s argument.

Fields

name: String

The name used to refer to this argument.

description: Option<String>

A short description of this argument that could be shown to the user in something like a tooltip.

default_value: Option<String>

Something that could be used as a default if no value was provided.

Implementations

impl ArgumentMetadata

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

Create a new ArgumentMetadata.

Panics

The name must not be empty.

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

Set the ArgumentMetadata::description.

pub fn with_default_value(self, default_value: impl Into<String>) -> Self

Set the ArgumentMetadata::default_value.

Trait Implementations

impl Clone for ArgumentMetadata

fn clone(&self) -> ArgumentMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentMetadata

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

Formats the value using the given formatter.

impl From<&str> for ArgumentMetadata

fn from(name: &str) -> Self

Converts to this type from the input type.

impl PartialEq<ArgumentMetadata> for ArgumentMetadata

fn eq(&self, other: &ArgumentMetadata) -> 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 Eq for ArgumentMetadata

impl StructuralEq for ArgumentMetadata

impl StructuralPartialEq for ArgumentMetadata