difftreelog
docs Add missing docs to lib.rs of CLI
in: master
1 file changed
crates/jrsonnet-cli/src/lib.rsdiffbeforeafterboth1mod ext;2mod manifest;3mod tla;4mod trace;56pub use ext::*;7pub use manifest::*;8pub use tla::*;9pub use trace::*;1011use clap::Clap;12use jrsonnet_evaluator::{error::Result, EvaluationState, FileImportResolver};13use std::path::PathBuf;1415pub trait ConfigureState {16 fn configure(&self, state: &EvaluationState) -> Result<()>;17}1819#[derive(Clap)]20// #[clap(help_heading = "INPUT")]21pub struct InputOpts {22 #[clap(23 long,24 short = 'e',25 about = "Treat input as code, evaluate them instead of reading file"26 )]27 pub evaluate: bool,2829 #[clap(about = "Path to the file to be compiled if `--evaluate` is unset, \30 otherwise code itself")]31 pub input: String,32}3334#[derive(Clap)]35// #[clap(help_heading = "OPTIONS")]36pub struct MiscOpts {37 /// Disable standard library.38 /// By default standard library will be available via global `std` variable.39 /// Note that standard library will still be loaded40 /// if chosen manifestification method is not `none`41 #[clap(long)]42 no_stdlib: bool,4344 /// Maximal allowed number of stack frames,45 /// stack overflow error will be raised if this number gets exceeded46 #[clap(long, short = 's', default_value = "200")]47 max_stack: usize,4849 /// Library search dirs.50 /// Any not found `imported` file will be searched in these.51 /// This can also be specified via `JSONNET_PATH` variable,52 /// which should contain a colon-separated (semicolon-separated on Windows) list of directories53 #[clap(long, short = 'J')]54 jpath: Vec<PathBuf>,55}56impl ConfigureState for MiscOpts {57 fn configure(&self, state: &EvaluationState) -> Result<()> {58 if !self.no_stdlib {59 state.with_stdlib();60 }6162 state.set_import_resolver(Box::new(FileImportResolver {63 library_paths: self.jpath.clone(),64 }));6566 state.set_max_stack(self.max_stack);67 Ok(())68 }69}7071/// General configuration of jsonnet72#[derive(Clap)]73#[clap(name = "jrsonnet", version, author)]74pub struct GeneralOpts {75 #[clap(flatten)]76 misc: MiscOpts,7778 #[clap(flatten)]79 tla: TLAOpts,80 #[clap(flatten)]81 ext: ExtVarOpts,8283 #[clap(flatten)]84 trace: TraceOpts,85}8687impl ConfigureState for GeneralOpts {88 fn configure(&self, state: &EvaluationState) -> Result<()> {89 // Configure trace first, because tla-code/ext-code can throw90 self.trace.configure(state)?;91 self.misc.configure(state)?;92 self.tla.configure(state)?;93 self.ext.configure(state)?;94 Ok(())95 }96}1mod ext;2mod manifest;3mod tla;4mod trace;56pub use ext::*;7pub use manifest::*;8pub use tla::*;9pub use trace::*;1011use clap::Clap;12use jrsonnet_evaluator::{error::Result, EvaluationState, FileImportResolver};13use std::path::PathBuf;1415pub trait ConfigureState {16 fn configure(&self, state: &EvaluationState) -> Result<()>;17}1819#[derive(Clap)]20// #[clap(help_heading = "INPUT")]21pub struct InputOpts {22 #[clap(23 long,24 short = 'e',25 about = "Treat input as code, evaluate them instead of reading file"26 )]27 pub evaluate: bool,2829 #[clap(30 about = "Path to the file to be compiled if `--evaluate` is unset, otherwise code itself"31 )]32 pub input: String,33}3435#[derive(Clap)]36// #[clap(help_heading = "OPTIONS")]37pub struct MiscOpts {38 /// Disable standard library.39 /// By default standard library will be available via global `std` variable.40 /// Note that standard library will still be loaded41 /// if chosen manifestification method is not `none`.42 #[clap(long)]43 no_stdlib: bool,4445 /// Maximal allowed number of stack frames,46 /// stack overflow error will be raised if this number gets exceeded.47 #[clap(long, short = 's', default_value = "200")]48 max_stack: usize,4950 /// Library search dirs.51 /// Any not found `imported` file will be searched in these.52 /// This can also be specified via `JSONNET_PATH` variable,53 /// which should contain a colon-separated (semicolon-separated on Windows) list of directories.54 #[clap(long, short = 'J')]55 jpath: Vec<PathBuf>,56}57impl ConfigureState for MiscOpts {58 fn configure(&self, state: &EvaluationState) -> Result<()> {59 if !self.no_stdlib {60 state.with_stdlib();61 }6263 state.set_import_resolver(Box::new(FileImportResolver {64 library_paths: self.jpath.clone(),65 }));6667 state.set_max_stack(self.max_stack);68 Ok(())69 }70}7172/// General configuration of jsonnet73#[derive(Clap)]74#[clap(name = "jrsonnet", version, author)]75pub struct GeneralOpts {76 #[clap(flatten)]77 misc: MiscOpts,7879 #[clap(flatten)]80 tla: TLAOpts,81 #[clap(flatten)]82 ext: ExtVarOpts,8384 #[clap(flatten)]85 trace: TraceOpts,86}8788impl ConfigureState for GeneralOpts {89 fn configure(&self, state: &EvaluationState) -> Result<()> {90 // Configure trace first, because tla-code/ext-code can throw91 self.trace.configure(state)?;92 self.misc.configure(state)?;93 self.tla.configure(state)?;94 self.ext.configure(state)?;95 Ok(())96 }97}