Struct DefineFunction

Source

pub struct DefineFunction { /* private fields */ }

Expand description

DEFINE FUNCTION fn::<name>(<args>) -> <ret> { <body> } — a user-defined SurrealQL function. The fn:: prefix is added automatically.

DefineFunction::new("greet")
    .arg("name", "string")
    .returns("string")
    .body("RETURN 'hi ' + $name;")
    .to_surrealql();

Implementations§

Source §

impl DefineFunction

Source

pub fn new(name: impl Into<String>) -> Self

Source

pub fn arg(self, name: impl Into<String>, ty: impl Into<String>) -> Self

Add a typed argument — $name: type.

Source

pub fn returns(self, ty: impl Into<String>) -> Self

Declared return type (-> <ty>).

Source

pub fn body(self, body: impl Into<String>) -> Self

The function body (raw SurrealQL statements, e.g. RETURN …;).

Source

pub fn overwrite(self) -> Self

Source

pub fn to_surrealql(&self) -> String

Source

pub fn remove(name: &str) -> String

REMOVE FUNCTION IF EXISTS fn::<name>.

Trait Implementations§

Source §

impl Display for DefineFunction

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for DefineFunction

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §