Struct Interface 

#[non_exhaustive]
pub struct Interface {
    pub name: String,
    pub module_name: String,
    pub package_id: String,
    pub package_name: String,
    pub view: Option<DamlType>,
    pub choices: Vec<Choice>,
}

A Daml interface: its view type and choices, plus the on-ledger identity a choice exercised through the interface needs. The marker struct itself is emitted from the interface’s DataCons::Interface data type; this adds the Interface/Choice impls on that marker.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The interface name (PascalCase) — also the marker struct’s name.

module_name: String

The Daml module the interface is defined in, dotted (e.g. Splice.Api…).

package_id: String

The id (hash) of the package the interface is defined in.

package_name: String

The Daml package name, for the #<package-name> id form.

view: Option<DamlType>

The interface’s view type (its viewtype), if known.

choices: Vec<Choice>

The choices the interface declares.

Implementations

impl Interface

pub fn new( name: impl Into<String>, module_name: impl Into<String>, package_id: impl Into<String>, package_name: impl Into<String>, ) -> Self

An interface with its on-ledger identity, no view and no choices yet.

Trait Implementations

impl Clone for Interface

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interface

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

Formats the value using the given formatter.

impl Eq for Interface

impl PartialEq for Interface

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Interface