Enum holochain_core::nucleus::ribosome::api::ZomeApiFunction

#[repr(usize)]
pub enum ZomeApiFunction {
    MissingNo,
    Abort,
    Debug,
    CommitAppEntry,
    GetAppEntry,
    InitGlobals,
    Call,
    LinkEntries,
    GetLinks,
    Query,
    HashEntry,
}

Enumeration of all the Zome Functions known and usable in Zomes. Enumeration can convert to str.

Variants

MissingNo

Error index for unimplemented functions

Abort

Abort is a way to receive useful debug info from assemblyscript memory allocators message: mem address in the wasm memory for an error message filename: mem address in the wasm memory for a filename line: line number column: column number

Debug

Zome API send debug information to the log debug(s: String)

CommitAppEntry

Commit an app entry to source chain commit_entry(entry_type: String, entry_value: String) -> Hash

GetAppEntry

Get an app entry from source chain by key (header hash) get_entry(address: Address) -> Entry

InitGlobals

Init Zome API Globals hc_init_globals() -> InitGlobalsOutput

Call

Call a zome function in a different capability or zome hc_call(zome_name: String, cap_name: String, fn_name: String, args: String);

LinkEntriesGetLinksQueryHashEntry

Methods

impl ZomeApiFunction

pub fn as_fn(     &self ) -> fn(_: &mut Runtime, _: &RuntimeArgs) -> Result<Option<RuntimeValue>, Trap>

Trait Implementations

impl Defn for ZomeApiFunction

fn as_str(&self) -> &'static str

return the canonical name of this function definition

fn str_to_index(s: &str) -> usize

convert the canonical name of this function to an index

fn from_index(i: usize) -> Self

convert an index to the function definition

fn capability(&self) -> ReservedCapabilityNames

impl Eq for ZomeApiFunction

impl PartialEq<ZomeApiFunction> for ZomeApiFunction

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for ZomeApiFunction

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

Formats the value using the given formatter.

impl FromStr for ZomeApiFunction

type Err = &'static str

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromPrimitive for ZomeApiFunction

fn from_i64(n: i64) -> Option<Self>

Convert an i64 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Convert an u64 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Convert an isize to return an optional value of this type. If the value cannot be represented by this value, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Convert an i8 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Convert an i16 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Convert an i32 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Convert an i128 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Convert a usize to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Convert an u8 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Convert an u16 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Convert an u32 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Convert an u128 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Convert a f32 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Convert a f64 to return an optional value of this type. If the type cannot be represented by this value, then None is returned.