Struct FunctionExport 

pub struct FunctionExport {
    pub name: Option<String>,
    pub args: Vec<(String, Kind)>,
    pub returns: Kind,
    pub args_text: Option<Vec<String>>,
    pub returns_text: Option<String>,
    pub writeable: bool,
    pub comment: Option<String>,
}

Fields

name: Option<String>

None for the default export, Some("name") for named exports.

args: Vec<(String, Kind)>

Named argument list: each entry is (arg_name, kind).

returns: Kind

args_text: Option<Vec<String>>

returns_text: Option<String>

writeable: bool

Whether this function may perform writes. Opt-in via #[surrealism(writeable)]. Defaults to false (read-only) for backward compatibility.

comment: Option<String>

Human-readable comment for this function, aligned with SurrealQL’s COMMENT clause. Sourced from Rust doc comments or #[surrealism(comment = "...")].

Implementations

impl FunctionExport

pub fn args_display(&self) -> String

pub fn returns_display(&self) -> String

Trait Implementations

impl Clone for FunctionExport

fn clone(&self) -> FunctionExport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionExport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionExport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FunctionExport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.