Struct DisplaySettings 

pub struct DisplaySettings { /* private fields */ }

Custom module display settings.

Implementations

impl DisplaySettings

pub fn new() -> Self

Create a new format settings.

Returns

A new instance of DisplaySettings.

pub fn with_show_param_id(self, flag: bool) -> Self

Sets a flag to show module parameters.

Arguments

• flag - Boolean flag to show module parameters.

Returns

Updated DisplaySettings instance.

pub fn with_show_all_attributes(self, flag: bool) -> Self

Sets a flag to show module attributes.

Arguments

• flag - Boolean flag to show all module attributes.

Returns

Updated DisplaySettings instance.

pub fn with_show_num_parameters(self, flag: bool) -> Self

Sets a flag to show the number of module parameters.

Arguments

• flag - Boolean flag to show the number of module parameters.

Returns

Updated DisplaySettings instance.

pub fn with_new_line_after_attribute(self, flag: bool) -> Self

Sets a flag to print a new line after an attribute.

Arguments

• flag - Boolean flag to print a new line after an attribute.

Returns

Updated DisplaySettings instance.

pub fn with_indentation_size(self, size: usize) -> Self

Sets the indentation size.

Arguments

• size - The size of the indentation.

Returns

Updated DisplaySettings instance.

pub fn inherit(self, top: Self) -> Self

Inherits settings from the provided settings and return a new settings object.

Arguments

• top - The top level DisplaySettings to inherit from.

Returns

Updated DisplaySettings instance.

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

A convenience method to wrap the DisplaySettings struct in an option.

Returns

An optional DisplaySettings.

pub fn level_up(self) -> Self

Increases the level of indentation.

Returns

Updated DisplaySettings instance with increased indentation level.

pub fn show_param_id(&self) -> bool

Gets show_param_id flag, substitutes false if not set.

This flag is used to print the module parameter ids.

Returns

A boolean value indicating whether to show parameter ids.

pub fn show_all_attributes(&self) -> bool

Gets show_all_attributes, substitutes false if not set.

This flag is used to force to print all module attributes, overriding custom attributes.

Returns

A boolean value indicating whether to show all attributes.

pub fn show_num_parameters(&self) -> bool

Gets show_num_parameters, substitutes true if not set.

This flag is used to print the number of module parameters.

Returns

A boolean value indicating whether to show the number of parameters.

pub fn new_line_after_attribute(&self) -> bool

Gets new_line_after_attribute, substitutes true if not set.

This flag is used to print a new line after an attribute.

Returns

A boolean value indicating whether to print a new line after an attribute.

pub fn indentation_size(&self) -> usize

Gets indentation_size, substitutes 2 if not set.

This flag is used to set the size of indentation.

Returns

An integer value indicating the size of indentation.

Trait Implementations

impl Clone for DisplaySettings

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplaySettings

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

Formats the value using the given formatter.

impl Default for DisplaySettings

fn default() -> Self

Returns the “default value” for a type.