Struct Vale 

pub struct Vale {
    pub version: Option<SemanticVersion>,
    pub binary: Option<PathBuf>,
    pub config: Option<ValeConfig>,
}

Vale installation details

Fields

version: Option<SemanticVersion>

Vale version

binary: Option<PathBuf>

Path to vale binary

config: Option<ValeConfig>

Path to Vale configuration

Implementations

impl Vale

pub fn init() -> ValeBuilder

Create an instance of Vale using the builder syntax

Trait Implementations

impl Clone for Vale

fn clone(&self) -> Vale

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Vale

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

Formats the value using the given formatter.

impl Default for Vale

fn default() -> Vale

Returns the “default value” for a type.

impl Display for Vale

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

Formats the value using the given formatter.

impl StaticAnalyzer<ValeConfig> for Vale

fn resolve( config: ValeConfig, is_offline: bool, skip_verify_checksum: bool, ) -> Vale

Resolve Vale

Notes

• Will use system vale command if available
• Will use local vale binary if available (will expect local binary if offline)
• Will download vale binary if not available by other means

fn command(self) -> String

Get command name (e.g. “vale”)

fn run(&self, id: String, content: String, output: Option<String>) -> Check

Run analyzer on content

fn download( self, config: Option<ValeConfig>, skip_verify_checksum: bool, ) -> Vale

Download binary

fn download_checksums(self) -> Result<HashMap<String, String>, String>

Download checksum values

fn extract(self, path: PathBuf, destination: Option<PathBuf>) -> PathBuf

Extract binary

fn sync(self, is_offline: bool) -> Result<(), Error>

Perform sync operation (only applies to Vale)

fn with_binary<P>(self, path: P) -> Self

where P: Into<PathBuf>,

Set binary

fn with_config(self, value: ValeConfig) -> Self

Set config

fn with_system_command(self) -> Self

Set system command

fn with_version(self, value: String) -> Self

Set version