Struct foundry_compilers::compilers::vyper::Vyper

pub struct Vyper {
    pub path: PathBuf,
    pub version: Version,
}

Fields

path: PathBuf

version: Version

Implementations

impl Vyper

pub fn new(path: impl AsRef<Path>) -> Result<Self>

Creates a new instance of the Vyper compiler. Uses the vyper binary in the system PATH.

pub fn compile_source( &self, path: impl AsRef<Path> ) -> Result<VyperCompilerOutput>

Convenience function for compiling all sources under the given path

pub fn compile_exact(&self, input: &VyperInput) -> Result<VyperCompilerOutput>

Same as Self::compile(), but only returns those files which are included in the CompilerInput.

In other words, this removes those files from the VyperCompilerOutput that are not included in the provided CompilerInput.

Examples

pub fn compile<T: Serialize>(&self, input: &T) -> Result<VyperCompilerOutput>

Compiles with --standard-json and deserializes the output as VyperCompilerOutput.

Examples

use foundry_compilers::{CompilerInput, Solc};

let solc = Solc::default();
let input = CompilerInput::new("./contracts")?;
let output = solc.compile(&input)?;

pub fn compile_as<T: Serialize, D: DeserializeOwned>( &self, input: &T ) -> Result<D>

Compiles with --standard-json and deserializes the output as the given D.

pub fn compile_output<T: Serialize>(&self, input: &T) -> Result<Vec<u8>>

Compiles with --standard-json and returns the raw stdout output.

pub fn version(vyper: impl Into<PathBuf>) -> Result<Version>

Invokes vyper --version and parses the output as a SemVer Version.

Trait Implementations

impl Clone for Vyper

fn clone(&self) -> Vyper

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Compiler for Vyper

const FILE_EXTENSIONS: &'static [&'static str] = VYPER_EXTENSIONS

Extensions of source files recognized by the compiler.

type Settings = VyperSettings

Compiler settings.

type CompilationError = VyperCompilationError

Error type returned by the compiler.

type ParsedSource = VyperParsedSource

Source parser used for resolving imports and version requirements.

type Input = VyperInput

Input type for the compiler. Contains settings and sources to be compiled.

fn compile(&self, input: &Self::Input) -> Result<VyperCompilerOutput>

Main entrypoint for the compiler. Compiles given input into CompilerOutput. Takes ownership over the input and returns back version with potential modifications made to it. Returned input is always the one which was seen by the binary.

fn version(&self) -> &Version

Returns the version of the compiler.

fn with_base_path(self, _base_path: PathBuf) -> Self

Builder method to set the base path for the compiler. Primarily used by solc implementation to se –base-path.

fn with_allowed_paths(self, _allowed_paths: BTreeSet<PathBuf>) -> Self

Builder method to set the allowed paths for the compiler. Primarily used by solc implementation to set –allow-paths.

fn with_include_paths(self, _include_paths: BTreeSet<PathBuf>) -> Self

Builder method to set the include paths for the compiler. Primarily used by solc implementation to set –include-paths.

impl Debug for Vyper

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

Formats the value using the given formatter.