Struct Index 

pub struct Index {
    pub beans: Vec<IndexEntry>,
}

Fields

beans: Vec<IndexEntry>

Implementations

impl Index

pub fn build(beans_dir: &Path) -> Result<Self>

Build the index by reading all bean files from the beans directory. Supports both new format ({id}-{slug}.md) and legacy format ({id}.yaml). Excludes config.yaml, index.yaml, and bean.yaml. Sorts entries by ID using natural ordering. Returns an error if duplicate bean IDs are detected.

pub fn is_stale(beans_dir: &Path) -> Result<bool>

Check whether the cached index is stale. Returns true if the index file is missing or if any bean file (.md or .yaml) in the beans directory has been modified after the index was last written.

pub fn load_or_rebuild(beans_dir: &Path) -> Result<Self>

Load the cached index or rebuild it if stale. This is the main entry point for read-heavy commands.

pub fn load(beans_dir: &Path) -> Result<Self>

Load the index from the cached index.yaml file.

pub fn save(&self, beans_dir: &Path) -> Result<()>

Save the index to .beans/index.yaml.

pub fn collect_archived(beans_dir: &Path) -> Result<Vec<IndexEntry>>

Collect all archived beans from .beans/archive/ directory. Walks through year/month subdirectories and loads all bean files. Returns IndexEntry items for archived beans.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Index

fn eq(&self, other: &Index) -> 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 Serialize for Index

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Index