Struct fj::models::Metadata

pub struct Metadata {
    pub name: String,
    pub version: String,
    pub short_description: Option<String>,
    pub description: Option<String>,
    pub homepage: Option<String>,
    pub repository: Option<String>,
    pub license: Option<String>,
}

Information about a particular module that can be used by the host for things like introspection and search.

Fields

name: String

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

version: String

A semver-compliant version number.

short_description: Option<String>

A short, one-line description.

description: Option<String>

A more elaborate description.

homepage: Option<String>

A link to the homepage.

repository: Option<String>

A link to the source code.

license: Option<String>

The name of the software license(s) this software is released under.

This is interpreted as a SPDX license expression (e.g. MIT OR Apache-2.0). See the SPDX site for more information.

Implementations

impl Metadata

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

Create a Metadata object with the bare minimum required fields.

Panics

The name and version fields must not be empty.

pub fn with_short_description(self, short_description: impl Into<String>) -> Self

Set the Metadata::short_description field.

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

Set the Metadata::description field.

pub fn with_homepage(self, homepage: impl Into<String>) -> Self

Set the Metadata::homepage field.

pub fn with_repository(self, repository: impl Into<String>) -> Self

Set the Metadata::repository field.

pub fn with_license(self, license: impl Into<String>) -> Self

Set the Metadata::license field.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl PartialEq<Metadata> for Metadata

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

impl StructuralEq for Metadata

impl StructuralPartialEq for Metadata