Struct cubist_sdk::gen::interface::file::FileInterfaces

pub struct FileInterfaces {
    pub interfaces: Vec<ContractInterface>,
    /* private fields */
}

All the contract interfaces corresponding to a particular file. If a file has four contracts and three are used cross chain, FileInterfaces’s interfaces will contain three contracts

Fields

interfaces: Vec<ContractInterface>

All the interfaces that correspond to contracts in a given file. If there are two contracts in the file, there will be two generated interfaces

Implementations

impl FileInterfaces

pub fn new(
    source: &SourceFile,
    config: &InterfaceConfig,
    target: Target
) -> Result<Self>

Given a source file and a config, generate interfaces for every contract in that file for a given target

pub fn is_empty(&self) -> bool

Returns true if this contract contains no interfaces

pub fn get_sender_target(&self) -> Target

Returns the chain that we’re exposing the contract to (e.g., Avalanche if we’re exposing EthStorage to Avalanche).

pub fn get_receiver_target(&self) -> Target

Returns the chain that the original contract lives on

pub fn get_source_path(&self) -> &PathBuf

Returns the full path of the source file

pub fn get_source_file(&self) -> &PathBuf

Returns just the source file relative to the contracts root dir. for /foo/bar/contracts/baz/Eth.sol, this will return baz/Eth.sol

pub fn get_file_stem(&self) -> Option<String>

Returns the file stem of source file, e.g., if the source file is eth.sol, this method returns eth

Trait Implementations

impl Debug for FileInterfaces

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

Formats the value using the given formatter.

impl Serialize for FileInterfaces

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

Serialize this value into the given Serde serializer.