Struct ink_metadata::InkProject

pub struct InkProject { /* private fields */ }

An entire ink! project for metadata file generation purposes.

Implementations

impl InkProject

pub fn new<L, S>(layout: L, spec: S) -> Self

where L: Into<Layout>, S: Into<ContractSpec>,

Create a new ink! project from a layout and a spec.

pub fn new_portable( layout: Layout<PortableForm>, spec: ContractSpec<PortableForm>, registry: PortableRegistry, ) -> Self

Create a new portable ink! project.

The caller is responsible to register all types into the supplied registry.

pub fn version(&self) -> &u64

Returns the metadata version used by the contract.

pub fn registry(&self) -> &PortableRegistry

Returns a read-only registry of types in the contract.

pub fn layout(&self) -> &Layout<PortableForm>

Returns the storage layout of the contract.

pub fn spec(&self) -> &ContractSpec<PortableForm>

Returns the specification of the contract.

Trait Implementations

impl Debug for InkProject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InkProject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for InkProject

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for InkProject

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

where __S: Serializer,

Serialize this value into the given Serde serializer.