Struct Description 

pub struct Description { /* private fields */ }

Implementations

impl Description

pub fn new(common: CommonAttributes, children: Vec<BodyElement>) -> Description

Trait Implementations

impl Clone for Description

fn clone(&self) -> Description

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Description

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

Formats the value using the given formatter.

impl Default for Description

fn default() -> Description

Returns the “default value” for a type.

impl Element for Description

fn ids(&self) -> &Vec<ID>

A list containing one or more unique identifier keys

fn ids_mut(&mut self) -> &mut Vec<ID>

fn names(&self) -> &Vec<NameToken>

a list containing the names of an element, typically originating from the element’s title or content. Each name in names must be unique; if there are name conflicts (two or more elements want to the same name), the contents will be transferred to the dupnames attribute on the duplicate elements. An element may have at most one of the names or dupnames attributes, but not both.

fn names_mut(&mut self) -> &mut Vec<NameToken>

fn source(&self) -> &Option<PathBuf>

fn source_mut(&mut self) -> &mut Option<PathBuf>

fn classes(&self) -> &Vec<String>

fn classes_mut(&mut self) -> &mut Vec<String>

impl From<Description> for SubOptionListItem

fn from(inner: Description) -> Self

Converts to this type from the input type.

impl HasChildren<BodyElement> for Description

fn with_children(children: Vec<BodyElement>) -> Description

fn children(&self) -> &Vec<BodyElement>

fn children_mut(&mut self) -> &mut Vec<BodyElement>

fn append_child<R: Into<C>>(&mut self, child: R)

fn append_children<R: Into<C> + Clone>(&mut self, more: &[R])

impl JsonSchema for Description

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Description

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

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 Description