Trait Compiler

pub trait Compiler:
    Send
    + Sync
    + Clone {
    type Input: CompilerInput<Settings = Self::Settings, Language = Self::Language>;
    type CompilationError: CompilationError;
    type CompilerContract: CompilerContract;
    type ParsedSource: ParsedSource<Language = Self::Language>;
    type Settings: CompilerSettings;
    type Language: Language;

    // Required methods
    fn compile(
        &self,
        input: &Self::Input,
    ) -> Result<CompilerOutput<Self::CompilationError, Self::CompilerContract>>;
    fn available_versions(
        &self,
        language: &Self::Language,
    ) -> Vec<CompilerVersion>;
}

The main compiler abstraction trait.

Currently mostly represents a wrapper around compiler binary aware of the version and able to compile given input into CompilerOutput including artifacts and errors.

Required Associated Types

type Input: CompilerInput<Settings = Self::Settings, Language = Self::Language>

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

type CompilationError: CompilationError

Error type returned by the compiler.

type CompilerContract: CompilerContract

Output data for each contract

type ParsedSource: ParsedSource<Language = Self::Language>

Source parser used for resolving imports and version requirements.

type Settings: CompilerSettings

Compiler settings.

type Language: Language

Enum of languages supported by the compiler.

Required Methods

fn compile( &self, input: &Self::Input, ) -> Result<CompilerOutput<Self::CompilationError, Self::CompilerContract>>

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 available_versions(&self, language: &Self::Language) -> Vec<CompilerVersion>

Returns all versions available locally and remotely. Should return versions with stripped metadata.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<'a, T: 'a + Compiler + ?Sized> Compiler for &'a T

where &'a T: Send + Sync + Clone,

type Input = <T as Compiler>::Input

type CompilationError = <T as Compiler>::CompilationError

type CompilerContract = <T as Compiler>::CompilerContract

type ParsedSource = <T as Compiler>::ParsedSource

type Settings = <T as Compiler>::Settings

type Language = <T as Compiler>::Language

fn compile( &self, input: &Self::Input, ) -> Result<CompilerOutput<Self::CompilationError, Self::CompilerContract>>

fn available_versions(&self, language: &Self::Language) -> Vec<CompilerVersion>

impl<T: Compiler + ?Sized> Compiler for Box<T>

where Box<T>: Send + Sync + Clone,

type Input = <T as Compiler>::Input

type CompilationError = <T as Compiler>::CompilationError

type CompilerContract = <T as Compiler>::CompilerContract

type ParsedSource = <T as Compiler>::ParsedSource

type Settings = <T as Compiler>::Settings

type Language = <T as Compiler>::Language

fn compile( &self, input: &Self::Input, ) -> Result<CompilerOutput<Self::CompilationError, Self::CompilerContract>>

fn available_versions(&self, language: &Self::Language) -> Vec<CompilerVersion>

impl<T: Compiler + ?Sized> Compiler for Arc<T>

where Arc<T>: Send + Sync + Clone,

type Input = <T as Compiler>::Input

type CompilationError = <T as Compiler>::CompilationError

type CompilerContract = <T as Compiler>::CompilerContract

type ParsedSource = <T as Compiler>::ParsedSource

type Settings = <T as Compiler>::Settings

type Language = <T as Compiler>::Language

fn compile( &self, input: &Self::Input, ) -> Result<CompilerOutput<Self::CompilationError, Self::CompilerContract>>

fn available_versions(&self, language: &Self::Language) -> Vec<CompilerVersion>

Implementors

impl Compiler for SolcCompiler

type Input = SolcVersionedInput

type CompilationError = Error

type ParsedSource = SolData

type Settings = SolcSettings

type Language = SolcLanguage

type CompilerContract = Contract

impl Compiler for MultiCompiler

type Input = MultiCompilerInput

type CompilationError = MultiCompilerError

type ParsedSource = MultiCompilerParsedSource

type Settings = MultiCompilerSettings

type Language = MultiCompilerLanguage

type CompilerContract = Contract

impl Compiler for Vyper

type Settings = VyperSettings

type CompilationError = VyperCompilationError

type ParsedSource = VyperParsedSource

type Input = VyperVersionedInput

type Language = VyperLanguage

type CompilerContract = Contract