Struct nu_plugin_selector::Selector
source · [−]pub struct Selector {
pub query: String,
pub tag: Tag,
pub as_html: bool,
pub attribute: String,
pub as_table: Value,
pub inspect: bool,
}
Fields
query: String
tag: Tag
as_html: bool
attribute: String
as_table: Value
inspect: bool
Implementations
Trait Implementations
sourceimpl Plugin for Selector
impl Plugin for Selector
sourcefn config(&mut self) -> Result<Signature, ShellError>
fn config(&mut self) -> Result<Signature, ShellError>
The config
method is used to configure a plugin’s user interface / signature. Read more
sourcefn begin_filter(
&mut self,
call_info: CallInfo
) -> Result<Vec<ReturnValue>, ShellError>
fn begin_filter(
&mut self,
call_info: CallInfo
) -> Result<Vec<ReturnValue>, ShellError>
begin_filter
is the first method to be called if the Signature
of the plugin is configured to be filterable.
Any setup required for the plugin such as parsing arguments from CallInfo
or initializing data structures
can be done here. The CallInfo
parameter will contain data configured in the config
method of the Plugin trait. Read more
sourcefn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError>
fn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError>
filter
is called for every Value
that is processed by the plugin.
This method requires the plugin Signature
to be configured as filterable. Read more
sourcefn end_filter(
&mut self
) -> Result<Vec<Result<ReturnSuccess, ShellError>, Global>, ShellError>
fn end_filter(
&mut self
) -> Result<Vec<Result<ReturnSuccess, ShellError>, Global>, ShellError>
end_filter
is the last method to be called by the plugin after all Value
s are processed by the plugin.
This method requires the plugin Signature
to be configured as filterable. Read more
sourcefn sink(&mut self, _call_info: CallInfo, _input: Vec<Value, Global>)
fn sink(&mut self, _call_info: CallInfo, _input: Vec<Value, Global>)
sink
consumes the Value
s that are passed in, preventing further processing.
This method requires the plugin Signature
to be configured without filtering. Read more
fn quit(&mut self)
Auto Trait Implementations
impl RefUnwindSafe for Selector
impl Send for Selector
impl Sync for Selector
impl Unpin for Selector
impl UnwindSafe for Selector
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more