Enum BankStrategy

pub enum BankStrategy {
    Default,
    NoTests,
    Summary,
}

Strategy for generating code bank documentation.

This enum controls how the code bank generator processes and formats the code.

Examples

use codebank::BankStrategy;

// Use default strategy for complete code representation
let strategy = BankStrategy::Default;

// Use NoTests strategy to exclude test code
let strategy = BankStrategy::NoTests;

// Use Summary strategy for public interface only
let strategy = BankStrategy::Summary;

Variants

Default

Generate the full code bank for the given directory using default settings. This includes all code elements with their complete implementations.

Examples

use codebank::{Bank, BankStrategy, CodeBank};
use std::path::Path;

let code_bank = CodeBank::try_new()?;

// Generate complete documentation
let content = code_bank.generate(
    Path::new("src"),  // Use your source directory
    BankStrategy::Default
)?;

assert!(content.contains("# Code Bank"));

NoTests

Generate the code bank without tests. This excludes test modules, test functions, and other test-related code.

Examples

use codebank::{Bank, BankStrategy, CodeBank, Result};
use std::path::Path;

let code_bank = CodeBank::try_new()?;

// Generate documentation excluding tests
let content = code_bank.generate(
    Path::new("src"),  // Use your source directory
    BankStrategy::NoTests
)?;

// Content should not contain test-related code
let lines = content.lines().collect::<Vec<_>>();
assert!(!lines.iter().any(|line| line.starts_with(&"#[cfg(test)]")));
assert!(!lines.iter().any(|line| line.starts_with(&"#[test]")));
assert!(!lines.iter().any(|line| line.starts_with(&"mod tests {")));

Summary

Generate a summary, skip all non public units. For functions, only contain signature and skip the body.

Examples

use codebank::{Bank, BankStrategy, CodeBank};
use std::path::Path;

let code_bank = CodeBank::try_new()?;

// Generate public interface summary
let content = code_bank.generate(
    Path::new("src"),  // Use your source directory
    BankStrategy::Summary
)?;

// Content should contain function signatures but not implementations
assert!(content.contains("{ ... }"));

Trait Implementations

impl Clone for BankStrategy

fn clone(&self) -> BankStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BankStrategy

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

Formats the value using the given formatter.

impl Default for BankStrategy

fn default() -> BankStrategy

Returns the “default value” for a type.

impl PartialEq for BankStrategy

fn eq(&self, other: &BankStrategy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BankStrategy

impl Eq for BankStrategy

impl StructuralPartialEq for BankStrategy