ast_grep_language

Enum SupportLang

pub enum SupportLang {
Show 23 variants    Bash,
    C,
    Cpp,
    CSharp,
    Css,
    Go,
    Elixir,
    Haskell,
    Html,
    Java,
    JavaScript,
    Json,
    Kotlin,
    Lua,
    Php,
    Python,
    Ruby,
    Rust,
    Scala,
    Swift,
    Tsx,
    TypeScript,
    Yaml,
}

Expand description

Represents all built-in languages.

Variants§

Bash

C

Cpp

CSharp

Css

Go

Elixir

Haskell

Html

Java

JavaScript

Json

Kotlin

Lua

Php

Python

Ruby

Rust

Scala

Swift

Tsx

TypeScript

Yaml

Implementations§

impl SupportLang

pub const fn all_langs() -> &'static [SupportLang]

pub fn file_types(&self) -> Types

Trait Implementations§

impl Clone for SupportLang

fn clone(&self) -> SupportLang

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for SupportLang

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for SupportLang

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for SupportLang

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

Formats the value using the given formatter. Read more

impl From<Bash> for SupportLang

fn from(_: Bash) -> Self

Converts to this type from the input type.

impl From<C> for SupportLang

fn from(_: C) -> Self

Converts to this type from the input type.

impl From<CSharp> for SupportLang

fn from(_: CSharp) -> Self

Converts to this type from the input type.

impl From<Cpp> for SupportLang

fn from(_: Cpp) -> Self

Converts to this type from the input type.

impl From<Css> for SupportLang

fn from(_: Css) -> Self

Converts to this type from the input type.

impl From<Elixir> for SupportLang

fn from(_: Elixir) -> Self

Converts to this type from the input type.

impl From<Go> for SupportLang

fn from(_: Go) -> Self

Converts to this type from the input type.

impl From<Haskell> for SupportLang

fn from(_: Haskell) -> Self

Converts to this type from the input type.

impl From<Html> for SupportLang

fn from(_: Html) -> Self

Converts to this type from the input type.

impl From<Java> for SupportLang

fn from(_: Java) -> Self

Converts to this type from the input type.

impl From<JavaScript> for SupportLang

fn from(_: JavaScript) -> Self

Converts to this type from the input type.

impl From<Json> for SupportLang

fn from(_: Json) -> Self

Converts to this type from the input type.

impl From<Kotlin> for SupportLang

fn from(_: Kotlin) -> Self

Converts to this type from the input type.

impl From<Lua> for SupportLang

fn from(_: Lua) -> Self

Converts to this type from the input type.

impl From<Php> for SupportLang

fn from(_: Php) -> Self

Converts to this type from the input type.

impl From<Python> for SupportLang

fn from(_: Python) -> Self

Converts to this type from the input type.

impl From<Ruby> for SupportLang

fn from(_: Ruby) -> Self

Converts to this type from the input type.

impl From<Rust> for SupportLang

fn from(_: Rust) -> Self

Converts to this type from the input type.

impl From<Scala> for SupportLang

fn from(_: Scala) -> Self

Converts to this type from the input type.

impl From<Swift> for SupportLang

fn from(_: Swift) -> Self

Converts to this type from the input type.

impl From<Tsx> for SupportLang

fn from(_: Tsx) -> Self

Converts to this type from the input type.

impl From<TypeScript> for SupportLang

fn from(_: TypeScript) -> Self

Converts to this type from the input type.

impl From<Yaml> for SupportLang

fn from(_: Yaml) -> Self

Converts to this type from the input type.

impl FromStr for SupportLang

Implements the language names and aliases.

type Err = SupportLangErr

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

impl Hash for SupportLang

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

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more

impl Language for SupportLang

fn kind_to_id(&self, kind: &str) -> u16

fn field_to_id(&self, field: &str) -> Option<u16>

fn meta_var_char(&self) -> char

Configure meta variable special character By default $ is the metavar char, but in PHP it can be #

fn expando_char(&self) -> char

Some language does not accept $ as the leading char for identifiers. We need to change $ to other char at run-time to make parser happy, thus the name expando. By default this is the same as meta_var char so replacement is done at runtime.

fn extract_meta_var(&self, source: &str) -> Option<MetaVariable>

extract MetaVariable from a given source string At runtime we need to use expand_char

fn build_pattern( &self, builder: &PatternBuilder<'_>, ) -> Result<Pattern, PatternError>

fn pre_process_pattern<'q>(&self, query: &'q str) -> Cow<'q, str>

normalize pattern code before matching e.g. remove expression_statement, or prefer parsing {} to object over block

fn from_path<P: AsRef<Path>>(path: P) -> Option<Self>

Return the file language from path. Return None if the file type is not supported.

impl LanguageExt for SupportLang

fn get_ts_language(&self) -> TSLanguage

tree sitter language to parse the source

fn injectable_languages(&self) -> Option<&'static [&'static str]>

fn extract_injections<L: LanguageExt>( &self, root: Node<'_, StrDoc<L>>, ) -> HashMap<String, Vec<TSRange>>

get injected language regions in the root document. e.g. get JavaScripts in HTML it will return a list of tuples of (language, regions). The first item is the embedded region language, e.g. javascript The second item is a list of regions in tree_sitter. also see https://tree-sitter.github.io/tree-sitter/using-parsers#multi-language-documents

fn ast_grep<S>(&self, source: S) -> Root<StrDoc<Self>>
where S: AsRef<str>,

Create an AstGrep instance for the language

impl PartialEq for SupportLang

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

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

1.0.0 · Source§

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 Serialize for SupportLang

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl Copy for SupportLang

impl Eq for SupportLang

impl StructuralPartialEq for SupportLang

Auto Trait Implementations§

impl Freeze for SupportLang

impl RefUnwindSafe for SupportLang

impl Send for SupportLang

impl Sync for SupportLang

impl Unpin for SupportLang

impl UnwindSafe for SupportLang

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,