Struct SqlFunArgs 

pub struct SqlFunArgs { /* private fields */ }

Common sql-fun CLI arguments and environment variables

Implementations

impl SqlFunArgs

pub fn metadata_format(&self) -> &str

gets metadata format value in args

pub fn metadata_file_raw(&self) -> Result<&str, SqlFunArgsError>

return raw value for --metadata-file

Errors

Returns SqlFunArgsError::NotSupported if the metadata format is not TOML.

pub fn metadata_file(&self) -> Result<PathBuf, SqlFunArgsError>

search metadata file with same-owner policy

Errors

Propagates errors when current directory or metadata path resolution fails.

pub fn schema_file( &self, metadata_file: &Path, ) -> Result<PathBuf, SqlFunArgsError>

get schema file

Errors

Returns SqlFunArgsError::FilePathNotFound when the schema file is missing.

impl SqlFunArgs

pub fn sql_fun_home(&self) -> Result<PathBuf, SqlFunArgsError>

get home dir path

If --sql-fun-home or SQL_FUN_HOME env present : configured value Else returns ${HOME}/.sql-fun

Errors

Returns SqlFunArgsError when the home directory cannot be resolved.

impl SqlFunArgs

pub fn is_builtin(&self) -> bool

returns true for builtin subcommand

pub fn sql_dialect( &self, metadata: &SqlFunMetadata, ) -> Result<SqlDialect, SqlFunArgsError>

get SQL dialect

Errors

Returns SqlFunArgsError when dialect resolution fails.

pub fn cte_catalog_dir( &self, metadata: &SqlFunMetadata, ) -> Result<Option<PathBuf>, SqlFunArgsError>

get CTE catalog directory

Errors

Propagates SqlFunArgsError from metadata lookups.

pub fn command(&self) -> &Option<CliSubCommand>

get command

pub fn postgres_version( &self, metadata: &SqlFunMetadata, ) -> Result<EngineVersion, SqlFunArgsError>

get PostgreSQL version

Errors

Returns SqlFunArgsError when the version cannot be determined.

pub fn postgres_search_path( &self, metadata: &SqlFunMetadata, ) -> Result<Vec<String>, SqlFunArgsError>

get PostgreSQL search path

Errors

Returns SqlFunArgsError when metadata retrieval fails.

pub fn postgres_extensions( &self, metadata: &SqlFunMetadata, ) -> Result<PostgresExtensionsCollection, SqlFunArgsError>

get postgres extensions

Errors

Propagates SqlFunArgsError if metadata lookup fails or the extension configuration is invalid.

pub fn builtin_info_dir( &self, metadata: &SqlFunMetadata, ) -> Result<PathBuf, SqlFunArgsError>

get builtin schema directory path

Errors

Returns SqlFunArgsError if the builtin directory cannot be resolved.

pub fn postgres_extensions_dir( &self, metadata: &SqlFunMetadata, ) -> Result<PathBuf, SqlFunArgsError>

set directory path of extensions

Errors

Returns SqlFunArgsError when the path components cannot be derived.

pub fn environments(&self) -> Result<HashMap<String, String>, SqlFunArgsError>

get environemnts for child process

Errors

Returns SqlFunArgsError if metadata fails to load or env generation encounters an error.

pub fn term_color(&self) -> TerminalColor

get terminal color value

pub fn highlighter_theme(&self) -> Result<HighlighterTheme, SqlFunArgsError>

get syntax highlighter theme

when Self::term_color is never, returns HighlighterTheme::default when Self::highlighter_theme is None, returns ${SQL_FUN_HOME}/highlighter/default.toml when Self::highlighter_theme is Some and relative path, returns ${SQL_FUN_HOME}/highlighter/specified-path when Self::highlighter_theme is Some and absolute path, returns load from absolute path

Errors

Returns SqlFunArgsError if faild load theme.

impl SqlFunArgs

pub fn parse_args() -> Self

Initialize and parse arguments

pub fn try_from_env() -> Result<Self, SqlFunArgsError>

Initialize for proc_macro

Errors

Returns SqlFunArgsError if failed

Trait Implementations

impl Args for SqlFunArgs

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for SqlFunArgs

fn clone(&self) -> SqlFunArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for SqlFunArgs

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for SqlFunArgs

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SqlFunArgs

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for SqlFunArgs

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for SqlFunArgs

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for SqlFunArgs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.