Skip to main content

Registration

shrub_core::builtins

Struct Registration 

Source 
pub struct Registration<SE: ShellExtensions> {
    pub execute_func: CommandExecuteFunc<SE>,
    pub content_func: CommandContentFunc,
    pub disabled: bool,
    pub special_builtin: bool,
    pub declaration_builtin: bool,
}
Expand description

Encapsulates a registration for a built-in command.

Fields§

§execute_func: CommandExecuteFunc<SE>

Function to execute the builtin.

§content_func: CommandContentFunc

Function to retrieve the builtin’s content/help text.

§disabled: bool

Has this registration been disabled?

§special_builtin: bool

Is the builtin classified as “special” by specification?

§declaration_builtin: bool

Is this builtin one that takes specially handled declarations?

Implementations§

Source§

impl<SE: ShellExtensions> Registration<SE>

Source

pub const fn special(self) -> Self

Updates the given registration to mark it for a special builtin.

Trait Implementations§

Source§

impl<SE: Clone + ShellExtensions> Clone for Registration<SE>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<SE> Freeze for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: Freeze,

§

impl<SE> RefUnwindSafe for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: RefUnwindSafe,

§

impl<SE> Send for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: Send,

§

impl<SE> Sync for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: Sync,

§

impl<SE> Unpin for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: Unpin,

§

impl<SE> UnsafeUnpin for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: UnsafeUnpin,

§

impl<SE> UnwindSafe for Registration<SE>
where fn(ExecutionContext<'_, SE>, Vec<CommandArg>) -> Pin<Box<dyn Future<Output = Result<ExecutionResult, Error>> + Send + '_>>: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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<U> 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§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more