workspace_basic_usage/
workspace_basic_usage.rs

1//! basic usage example for `workspace_tools`
2//!
3//! this example demonstrates the core functionality of workspace path resolution
4
5use workspace_tools::{ workspace, WorkspaceError };
6
7fn main() -> Result< (), WorkspaceError >
8{
9  // ensure we have a workspace path set
10  if std::env::var( "WORKSPACE_PATH" ).is_err()
11  {
12    println!( "setting WORKSPACE_PATH to current directory for demo" );
13    std::env::set_var( "WORKSPACE_PATH", std::env::current_dir().unwrap() );
14  }
15
16  // get workspace instance
17  println!( "resolving workspace..." );
18  let ws = workspace()?;
19  
20  println!( "workspace root: {}", ws.root().display() );
21  
22  // demonstrate standard directory access
23  println!( "\nstandard directories:" );
24  println!( "  config: {}", ws.config_dir().display() );
25  println!( "  data: {}", ws.data_dir().display() );
26  println!( "  logs: {}", ws.logs_dir().display() );
27  println!( "  docs: {}", ws.docs_dir().display() );
28  println!( "  tests: {}", ws.tests_dir().display() );
29  
30  // demonstrate path joining
31  println!( "\npath joining examples:" );
32  let app_config = ws.join( "config/app.toml" );
33  let cache_file = ws.join( "data/cache.db" );
34  let log_file = ws.join( "logs/application.log" );
35  
36  println!( "  app config: {}", app_config.display() );
37  println!( "  cache file: {}", cache_file.display() );
38  println!( "  log file: {}", log_file.display() );
39  
40  // demonstrate workspace boundary checking
41  println!( "\nworkspace boundary checking:" );
42  println!( "  app_config in workspace: {}", ws.is_workspace_file( &app_config ) );
43  println!( "  /etc/passwd in workspace: {}", ws.is_workspace_file( "/etc/passwd" ) );
44  
45  // validate workspace
46  println!( "\nvalidating workspace..." );
47  match ws.validate()
48  {
49    Ok( () ) => println!( "  workspace structure is valid" ),
50    Err( e ) => println!( "  workspace validation failed: {e}" ),
51  }
52  
53  Ok( () )
54}
workspace_basic_usage/workspace_basic_usage.rs

workspace_basic_usage/
workspace_basic_usage.rs
