Struct Builtin 

#[non_exhaustive]
pub struct Builtin {
    pub type: Type,
    pub execute: Main,
    pub is_declaration_utility: Option<bool>,
}

Built-in utility definition

Notes on equality

Although this type implements PartialEq, comparison between instances of this type may not always yield predictable results due to the presence of function pointers. As a result, it is recommended to avoid relying on equality comparisons for values of this type. See https://doc.rust-lang.org/std/ptr/fn.fn_addr_eq.html for the characteristics of function pointer comparisons.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: Type

Type of the built-in

execute: Main

Function that implements the behavior of the built-in

is_declaration_utility: Option<bool>

Whether the built-in is a declaration utility

The decl_util::Glossary implementation for Env uses this field to determine whether a command name is a declaration utility. See the method description for the value this field should have.

Implementations

impl Builtin

pub const fn new(type: Type, execute: Main) -> Self

Creates a new built-in utility definition.

The type and execute fields are set to the given arguments. The is_declaration_utility field is set to Some(false), indicating that the built-in is not a declaration utility.

Trait Implementations

impl Clone for Builtin

fn clone(&self) -> Builtin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builtin

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

Formats the value using the given formatter.

impl Hash for Builtin

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Builtin

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Builtin

impl Eq for Builtin

impl StructuralPartialEq for Builtin