Struct foundry_config::BasicConfig

pub struct BasicConfig {
    pub profile: Profile,
    pub src: PathBuf,
    pub out: PathBuf,
    pub libs: Vec<PathBuf>,
    pub remappings: Vec<RelativeRemapping>,
}

A subset of the foundry Config used to initialize a foundry.toml file

Example

use foundry_config::{Config, BasicConfig};
use serde::Deserialize;

let my_config = Config::figment().extract::<BasicConfig>();

Fields

profile: Profile

the profile tag: [profile.default]

src: PathBuf

path of the source contracts dir, like src or contracts

out: PathBuf

path to where artifacts shut be written to

libs: Vec<PathBuf>

all library folders to include, lib, node_modules

remappings: Vec<RelativeRemapping>

Remappings to use for this repo

Implementations

impl BasicConfig

pub fn to_string_pretty(&self) -> Result<String, Error>

Serialize the config as a String of TOML.

This serializes to a table with the name of the profile

Trait Implementations

impl Clone for BasicConfig

fn clone(&self) -> BasicConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BasicConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<BasicConfig> for BasicConfig

fn eq(&self, other: &BasicConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BasicConfig

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 BasicConfig

impl StructuralEq for BasicConfig

impl StructuralPartialEq for BasicConfig