Skip to main content

CommandFactRef

Struct CommandFactRef 

Source
pub struct CommandFactRef<'facts, 'a> { /* private fields */ }
Expand description

Extracted structural facts available to rules and callers.

Implementations§

Source§

impl<'facts, 'a> CommandFactRef<'facts, 'a>

Source

pub fn id(self) -> CommandId

Source

pub fn key(self) -> FactSpan

Source

pub fn is_nested_word_command(self) -> bool

Source

pub fn scope(self) -> ScopeId

Source

pub fn enclosing_function_scope(self) -> Option<ScopeId>

Source

pub fn stmt(self) -> &'a Stmt

Source

pub fn command(self) -> &'a Command

Source

pub fn span(self) -> Span

Source

pub fn span_in_source(self, source: &str) -> Span

Source

pub fn redirects(self) -> &'a [Redirect]

Source

pub fn zsh_options(self) -> Option<&'facts ZshOptionState>

Source

pub fn redirect_facts(self) -> &'facts [RedirectFact<'a>]

Source

pub fn substitution_facts(self) -> &'facts [SubstitutionFact]

Source

pub fn scope_read_source_words(self) -> &'facts [PathWordFact<'a>]

Source

pub fn declaration_assignment_probes( self, ) -> &'facts [DeclarationAssignmentProbe]

Source

pub fn normalized(self) -> &'facts NormalizedCommand<'a>

Source

pub fn options(self) -> CommandOptionFactsRef<'facts, 'a>

Source

pub fn glued_closing_bracket_operand_span(self) -> Option<Span>

Source

pub fn glued_closing_bracket_insert_offset(self) -> Option<usize>

Source

pub fn linebreak_in_test_anchor_span(self) -> Option<Span>

Source

pub fn linebreak_in_test_insert_offset(self) -> Option<usize>

Source

pub fn simple_test(self) -> Option<&'facts SimpleTestFact<'a>>

Source

pub fn conditional(self) -> Option<&'facts ConditionalFact<'a>>

Source

pub fn literal_name(self) -> Option<&'facts str>

Source

pub fn effective_name(self) -> Option<&'facts str>

Source

pub fn effective_or_literal_name(self) -> Option<&'facts str>

Source

pub fn effective_name_is(self, name: &str) -> bool

Source

pub fn static_utility_name(self) -> Option<&'facts str>

Source

pub fn static_utility_name_is(self, name: &str) -> bool

Source

pub fn wrappers(self) -> &'facts [WrapperKind]

Source

pub fn has_wrapper(self, wrapper: WrapperKind) -> bool

Source

pub fn declaration(self) -> Option<&'facts NormalizedDeclaration<'a>>

Source

pub fn body_span(self) -> Span

Source

pub fn body_name_word(self) -> Option<&'a Word>

Source

pub fn command_name_word(self) -> Option<&'a Word>

Source

pub fn command_name_starts_with_literal_dash(self, source: &str) -> bool

Source

pub fn command_name_follows_escaped_semicolon(self, source: &str) -> bool

Source

pub fn command_name_word_unquoted_glob_spans(self, source: &str) -> Vec<Span>

Source

pub fn command_name_word_active_glob_spans_outside_brace_expansion( self, source: &str, ) -> Vec<Span>

Source

pub fn command_name_word_single_double_quoted_replacement( self, source: &str, ) -> Option<Box<str>>

Source

pub fn suspicious_body_name_bracket_glob_spans(self, source: &str) -> Vec<Span>

Source

pub fn body_word_span(self) -> Option<Span>

Source

pub fn body_word_contains_template_placeholder(self, source: &str) -> bool

Source

pub fn body_word_has_suspicious_quoted_command_trailer( self, source: &str, trailing_literal_char: Option<char>, ) -> bool

Source

pub fn body_word_has_hash_suffix(self, source: &str) -> bool

Source

pub fn bracket_command_name_needs_separator(self, source: &str) -> bool

Source

pub fn body_args(self) -> &'facts [&'a Word]

Source

pub fn file_operand_words(self) -> &'facts [&'a Word]

Source

pub fn shellcheck_command_span(self, source: &str) -> Option<Span>

Methods from Deref<Target = CommandFact<'a>>§

Source

pub fn id(&self) -> CommandId

Source

pub fn key(&self) -> FactSpan

Source

pub fn is_nested_word_command(&self) -> bool

Source

pub fn scope(&self) -> ScopeId

Source

pub fn enclosing_function_scope(&self) -> Option<ScopeId>

Source

pub fn stmt(&self) -> &'a Stmt

Source

pub fn command(&self) -> &'a Command

Source

pub fn span(&self) -> Span

Source

pub fn span_in_source(&self, source: &str) -> Span

Source

pub fn redirects(&self) -> &'a [Redirect]

Source

pub fn normalized(&self) -> &NormalizedCommand<'a>

Source

pub fn options(&self) -> CommandOptionFactsRef<'_, 'a>

Source

pub fn glued_closing_bracket_operand_span(&self) -> Option<Span>

Source

pub fn glued_closing_bracket_insert_offset(&self) -> Option<usize>

Source

pub fn linebreak_in_test_anchor_span(&self) -> Option<Span>

Source

pub fn linebreak_in_test_insert_offset(&self) -> Option<usize>

Source

pub fn simple_test(&self) -> Option<&SimpleTestFact<'a>>

Source

pub fn conditional(&self) -> Option<&ConditionalFact<'a>>

Source

pub fn literal_name(&self) -> Option<&str>

Source

pub fn effective_name(&self) -> Option<&str>

Source

pub fn effective_or_literal_name(&self) -> Option<&str>

Source

pub fn effective_name_is(&self, name: &str) -> bool

Source

pub fn static_utility_name(&self) -> Option<&str>

Source

pub fn static_utility_name_is(&self, name: &str) -> bool

Source

pub fn wrappers(&self) -> &[WrapperKind]

Source

pub fn has_wrapper(&self, wrapper: WrapperKind) -> bool

Source

pub fn declaration(&self) -> Option<&NormalizedDeclaration<'a>>

Source

pub fn body_span(&self) -> Span

Source

pub fn body_name_word(&self) -> Option<&'a Word>

Source

pub fn body_word_span(&self) -> Option<Span>

Source

pub fn body_word_contains_template_placeholder(&self, source: &str) -> bool

Source

pub fn body_word_has_suspicious_quoted_command_trailer( &self, source: &str, trailing_literal_char: Option<char>, ) -> bool

Source

pub fn body_word_has_hash_suffix(&self, source: &str) -> bool

Source

pub fn bracket_command_name_needs_separator(&self, source: &str) -> bool

Source

pub fn body_args(&self) -> &[&'a Word]

Source

pub fn file_operand_words(&self) -> &[&'a Word]

Trait Implementations§

Source§

impl<'facts, 'a> Clone for CommandFactRef<'facts, 'a>

Source§

fn clone(&self) -> CommandFactRef<'facts, 'a>

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
Source§

impl<'facts, 'a> Copy for CommandFactRef<'facts, 'a>

Source§

impl<'facts, 'a> Debug for CommandFactRef<'facts, 'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'facts, 'a> Deref for CommandFactRef<'facts, 'a>

Source§

type Target = CommandFact<'a>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.

Auto Trait Implementations§

§

impl<'facts, 'a> Freeze for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> RefUnwindSafe for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> Send for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> Sync for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> Unpin for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> UnsafeUnpin for CommandFactRef<'facts, 'a>

§

impl<'facts, 'a> UnwindSafe for CommandFactRef<'facts, 'a>

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<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, 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.