Struct Config 

pub struct Config { /* private fields */ }

Configuration for wdl-analysis.

This type is a wrapper around an Arc, and so can be cheaply cloned and sent between threads.

Implementations

impl Config

pub fn diagnostics_config(&self) -> &DiagnosticsConfig

Get this configuration’s DiagnosticsConfig.

pub fn fallback_version(&self) -> Option<SupportedVersion>

Get this configuration’s fallback version; see Config::with_fallback_version().

pub fn ignore_filename(&self) -> Option<&str>

Get this configuration’s ignore filename.

pub fn all_rules(&self) -> &[String]

Gets the list of all known rule identifiers.

pub fn with_diagnostics_config(&self, diagnostics: DiagnosticsConfig) -> Self

Return a new configuration with the previous DiagnosticsConfig replaced by the argument.

pub fn with_fallback_version( &self, fallback_version: Option<SupportedVersion>, ) -> Self

Return a new configuration with the previous version fallback option replaced by the argument.

This option controls what happens when analyzing a WDL document with a syntactically valid but unrecognized version in the version statement. The default value is None, with no fallback behavior.

Configured with Some(fallback_version), analysis will proceed as normal if the version statement contains a recognized version. If the version is unrecognized, analysis will continue as if the version statement contained fallback_version, though the concrete syntax of the version statement will remain unchanged.

Warnings

This option is intended only for situations where unexpected behavior due to unsupported syntax is acceptable, such as when providing best-effort editor hints via wdl-lsp. The semantics of executing a WDL workflow with an unrecognized version is undefined and not recommended.

Once this option has been configured for an Analyzer, it should not be changed. A document that was initially parsed and analyzed with one fallback option may cause errors if subsequent operations are performed with a different fallback option.

pub fn with_ignore_filename(&self, filename: Option<String>) -> Self

Return a new configuration with the previous ignore filename replaced by the argument.

Specifying None for filename disables ignore behavior. This is also the default.

Some(filename) will use filename as the ignorefile basename to search for. Child directories and parent directories are searched for a file with the same basename as filename and if a match is found it will attempt to be parsed as an ignorefile with a syntax similar to .gitignore files.

pub fn with_all_rules(&self, rules: Vec<String>) -> Self

Returns a new configuration with the list of all known rule identifiers replaced by the argument.

This is used internally to populate the #@ except: snippet.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config