Struct tarantool::proc::Proc

pub struct Proc { /* private fields */ }

Description of a tarantool stored procedure defined using the #[tarantool::proc] macro attribute.

See also all_procs.

Implementations

impl Proc

pub const fn new(name: &'static str, proc: Proc) -> Self

Create a new stored proc description.

This function is called when #[tarantool::proc] attribute is used, so users don’t usually use it directly.

See also module_path

pub const fn with_public(self, public: bool) -> Self

pub const fn name(&self) -> &'static str

Get the name of the stored procedure NOT including the module name.

pub const fn proc(&self) -> Proc

Get the proc’s function pointer.

This function is usually not necessary for defining tarantool’s stored procedures, the name is enough. But it is there if you need it for some reason.

pub const fn is_public(&self) -> bool

Returns true if the proc has pub visibility specifier, but can be overriden with the public attribute.

Can be used when choosing which stored procedures the “public” role should have access to.

See https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/_user/ for more info about role “public”.

Trait Implementations

impl Clone for Proc

fn clone(&self) -> Proc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Proc

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

Formats the value using the given formatter.

impl PartialEq for Proc

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Proc

impl StructuralEq for Proc

impl StructuralPartialEq for Proc