Struct Component

pub struct Component {
    pub key: String,
    pub name: String,
    pub description: String,
    pub component_set_id: Option<String>,
    pub documentation_links: Vec<DocumentationLink>,
    pub remote: bool,
}

Component : A description of a main component. Helps you identify which component instances are attached to.

Fields

key: String

The key of the component

name: String

Name of the component

description: String

The description of the component as entered in the editor

component_set_id: Option<String>

The ID of the component set if the component belongs to one

documentation_links: Vec<DocumentationLink>

An array of documentation links attached to this component

remote: bool

Whether this component is a remote component that doesn’t live in this file

Implementations

impl Component

pub fn new( key: String, name: String, description: String, documentation_links: Vec<DocumentationLink>, remote: bool, ) -> Component

A description of a main component. Helps you identify which component instances are attached to.

Trait Implementations

impl Clone for Component

fn clone(&self) -> Component

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Component

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

Formats the value using the given formatter.

impl Default for Component

fn default() -> Component

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Component

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Component

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Component

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Component