DidGenerator

generate_did

Struct DidGenerator 

Source 
pub struct DidGenerator { /* private fields */ }
Expand description

A struct for generating Candid (.did) files for Internet Computer canisters.

Most users should use the CLI (generate-did <canister_name>) instead of this struct directly.

Implementations§

Source§

impl DidGenerator

Source

pub fn new(canister_dir: PathBuf) -> Self

Creates a new DidGenerator instance.

§Arguments
  • canister_dir - The path to the canister directory
Source

pub fn generate(&self) -> Result<()>

Generates the .did file for the specified canister.

This function:

  1. Builds the Rust canister
  2. Extracts the Candid interface using candid-extractor
  3. Writes the interface to a .did file
§Returns
  • Result<()> - Ok(()) if successful, Err if any step fails

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.