Trait SampleConfig

pub trait SampleConfig {
    const SAMPLE_OUTPUT_TYPE: OutputType;

    // Required methods
    fn generate_sample_yaml(&self) -> String;
    fn generate_sample_json(&self) -> String;
}

Generate sample configs for Rust data constructs automatically using an example instance.

Required Associated Constants

const SAMPLE_OUTPUT_TYPE: OutputType

Whether this data construct produces a value (e.g. String) or fields (e.g. a struct).

Required Methods

fn generate_sample_yaml(&self) -> String

Generate a string containing the sample config in Yaml format.

fn generate_sample_json(&self) -> String

Generate a string containing the sample config in JSON format.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl SampleConfig for SocketAddr

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for bool

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for f32

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for f64

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for i8

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for i16

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for i32

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for i64

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for i128

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for isize

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for str

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for u8

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for u16

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for u32

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for u64

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for u128

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for usize

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for String

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for Path

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl SampleConfig for PathBuf

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Value

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<'a, T: SampleConfig + ToOwned> SampleConfig for Cow<'a, T>

const SAMPLE_OUTPUT_TYPE: OutputType = T::SAMPLE_OUTPUT_TYPE

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for Option<T>

const SAMPLE_OUTPUT_TYPE: OutputType = T::SAMPLE_OUTPUT_TYPE

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for &T

const SAMPLE_OUTPUT_TYPE: OutputType = T::SAMPLE_OUTPUT_TYPE

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for &mut T

const SAMPLE_OUTPUT_TYPE: OutputType = T::SAMPLE_OUTPUT_TYPE

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for [T]

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Fields

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for Box<T>

const SAMPLE_OUTPUT_TYPE: OutputType = T::SAMPLE_OUTPUT_TYPE

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

impl<T: SampleConfig> SampleConfig for Vec<T>

const SAMPLE_OUTPUT_TYPE: OutputType = OutputType::Fields

fn generate_sample_yaml(&self) -> String

fn generate_sample_json(&self) -> String

Implementors