Struct StructDoc

pub struct StructDoc { /* private fields */ }

Information about the struct.

Implementations

impl StructDoc

pub fn new(fields: Vec<FieldDoc>) -> StructDoc

Create an empty struct.

pub fn add_param( &mut self, name: &str, description: &str, environment_variable: Option<String>, default: Option<String>, example: Option<String>, is_mandatory: bool, )

Add information about one parameter.

pub fn merge_struct_doc(&self, s2: &StructDoc) -> StructDoc

Merge two StructDoc into a third one.

pub fn get_field(&self, name: &str) -> Option<&FieldDoc>

Get a field by its name.

pub fn get_ordered_data(&self) -> Vec<&FieldDoc>

Trait Implementations

impl Clone for StructDoc

fn clone(&self) -> StructDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructDoc

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

Formats the value using the given formatter.

impl Default for StructDoc

fn default() -> StructDoc

Returns the “default value” for a type.