Struct burn::module::Content

pub struct Content {
    pub attributes: Vec<Attribute>,
    pub single_item: Option<String>,
    pub display_settings: DisplaySettings,
    pub top_level_type: Option<String>,
}

Struct to store the attributes of a module for formatting.

Fields

attributes: Vec<Attribute>

List of attributes.

single_item: Option<String>

Single item content.

display_settings: DisplaySettings

Display settings.

top_level_type: Option<String>

Top level type name.

Implementations

impl Content

pub fn new(display_settings: DisplaySettings) -> Content

Creates a new attributes struct.

Arguments

• display_settings - Display settings for the content.

Returns

A new instance of Content.

pub fn add<T>(self, name: &str, value: &T) -> Content

where T: ModuleDisplay + ?Sized,

Adds an attribute to the format settings. The value will be formatted and stored as a string.

Arguments

• name - Name of the attribute.
• value - Value of the attribute.

Returns

Updated Content instance with the new attribute added.

pub fn add_single<T>(self, value: &T) -> Content

where T: ModuleDisplay + ?Sized,

Adds a single item.

Arguments

• value - Rendered string of the single item.

Returns

Updated Content instance with the single item added.

pub fn add_formatted<T>(self, value: &T) -> Content

where T: Display,

Adds a single item.

Arguments

• value - Formatted display value.

Returns

Updated Content instance with the formatted single item added.

pub fn optional(self) -> Option<Content>

A convenience method to wrap the Attributes struct in an option because it is often used as an optional field.

Returns

An optional Content.

pub fn set_top_level_type(self, ty: &str) -> Content

Sets the top level type name.

Arguments

• ty - The type name to set.

Returns

Updated Content instance with the top level type name set.

Trait Implementations

impl Clone for Content

fn clone(&self) -> Content

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Content

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

Formats the value using the given formatter.