Struct UsageExample 

pub struct UsageExample {
    pub title: String,
    pub description: String,
    pub code: String,
    pub category: ExampleCategory,
    pub difficulty: ExampleDifficulty,
    pub runnable: bool,
}

Usage example for a trait.

Provides practical examples of how to use a trait, including code samples and explanations.

Fields

• title - Brief title for the example
• description - Detailed description of what the example demonstrates
• code - Actual code content
• category - Category of the example (Implementation, Usage, etc.)
• difficulty - Difficulty level (Beginner, Intermediate, Advanced)
• runnable - Whether the example can be executed

Examples

use sklears_core::trait_explorer::trait_registry::*;

let example = UsageExample {
    title: "Basic Estimator Implementation".to_string(),
    description: "Shows how to implement the Estimator trait".to_string(),
    code: r#"
impl Estimator for MyEstimator {
    type Config = MyConfig;

    fn name(&self) -> &'static str {
        "MyEstimator"
    }
}
"#.to_string(),
    category: ExampleCategory::Implementation,
    difficulty: ExampleDifficulty::Beginner,
    runnable: true,
};

assert_eq!(example.difficulty, ExampleDifficulty::Beginner);
assert!(example.runnable);

Fields

title: String

Title of the example

description: String

Description of what the example shows

code: String

Code content

category: ExampleCategory

Category of example

difficulty: ExampleDifficulty

Difficulty level

runnable: bool

Whether the example can be run

Trait Implementations

impl Clone for UsageExample

fn clone(&self) -> UsageExample

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsageExample

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UsageExample

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for UsageExample

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.