Skip to main content

QueryBuilder

Struct QueryBuilder 

Source
pub struct QueryBuilder { /* private fields */ }
Expand description

Builder for constructing type-safe queries.

§Example

use sqry_core::query::builder::QueryBuilder;

let query = QueryBuilder::kind("function")
    .and(QueryBuilder::lang("rust"))
    .and_not(QueryBuilder::name_matches("test.*"))
    .build()?;

Implementations§

Source§

impl QueryBuilder

Source

pub fn new() -> Self

Create empty builder for chaining

Source

pub fn kind(value: impl Into<String>) -> Self

Filter by symbol kind (function, method, class, etc.)

Source

pub fn kind_any(values: &[&str]) -> Self

Filter by multiple symbol kinds (OR)

Source

pub fn name(value: impl Into<String>) -> Self

Filter by symbol name (exact match)

Source

pub fn name_matches(pattern: impl Into<String>) -> Self

Filter by symbol name (regex match with default flags)

Source

pub fn name_matches_with<F>(pattern: impl Into<String>, configure: F) -> Self

Filter by symbol name (regex match with custom flags via closure)

§Example
// Case-insensitive name matching
QueryBuilder::name_matches_with("test.*", |rb| rb.case_insensitive())
Source

pub fn lang(value: impl Into<String>) -> Self

Filter by programming language

Source

pub fn language(value: impl Into<String>) -> Self

Filter by programming language (alias for lang)

Source

pub fn path(value: impl Into<String>) -> Self

Filter by file path (exact or glob match)

Source

pub fn file(value: impl Into<String>) -> Self

Filter by file path (alias for path)

Source

pub fn path_matches(pattern: impl Into<String>) -> Self

Filter by file path (regex match with default flags)

Source

pub fn path_matches_with<F>(pattern: impl Into<String>, configure: F) -> Self

Filter by file path (regex match with custom flags via closure)

§Example
// Case-insensitive path matching
QueryBuilder::path_matches_with(".*test.*", |rb| rb.case_insensitive())
Source

pub fn repo(value: impl Into<String>) -> Self

Filter by repository

Source

pub fn parent(value: impl Into<String>) -> Self

Filter by parent symbol

Source

pub fn text_matches(pattern: impl Into<String>) -> Self

Filter by text content (regex only, default flags)

Source

pub fn text_matches_with<F>(pattern: impl Into<String>, configure: F) -> Self

Filter by text content (regex with custom flags via closure)

§Example
// Multi-line text matching
QueryBuilder::text_matches_with("^pub fn.*$", |rb| rb.multiline())
Source

pub fn callers(symbol: impl Into<String>) -> Self

Filter symbols that call the specified symbol

Source

pub fn callees(symbol: impl Into<String>) -> Self

Filter symbols called by the specified symbol

Source

pub fn imports(module: impl Into<String>) -> Self

Filter symbols that import the specified module

Source

pub fn exports(value: impl Into<String>) -> Self

Filter symbols that export something

Source

pub fn returns(type_name: impl Into<String>) -> Self

Filter symbols with the specified return type

Source

pub fn references(symbol: impl Into<String>) -> Self

Filter symbols that reference the specified symbol

Source

pub fn scope(value: impl Into<String>) -> Self

Filter by scope (file, module, class, function, block)

This targets the core scope field (enum type).

Source

pub fn scope_type(value: impl Into<String>) -> Self

Filter by scope type (module, function, class, struct, method, block, etc.)

This targets the scope.type compound field for nested scope filtering.

Source

pub fn scope_name(value: impl Into<String>) -> Self

Filter by scope name

Source

pub fn scope_parent(value: impl Into<String>) -> Self

Filter by scope parent

Source

pub fn scope_ancestor(value: impl Into<String>) -> Self

Filter by scope ancestor (transitive parent)

Source

pub fn field(name: impl Into<String>, value: impl Into<Value>) -> Self

Access any field by name with a value

Source

pub fn field_matches( name: impl Into<String>, pattern: impl Into<String>, ) -> Self

Access any field by name with regex match (default flags)

Source

pub fn field_matches_with<F>( name: impl Into<String>, pattern: impl Into<String>, configure: F, ) -> Self

Access any field by name with regex match (custom flags via closure)

§Example
// Case-insensitive field matching
QueryBuilder::field_matches_with("custom_field", "pattern.*", |rb| rb.case_insensitive())
Source

pub fn field_gt(name: impl Into<String>, value: i64) -> Self

Numeric comparison: field > value

Source

pub fn field_gte(name: impl Into<String>, value: i64) -> Self

Numeric comparison: field >= value

Source

pub fn field_lt(name: impl Into<String>, value: i64) -> Self

Numeric comparison: field < value

Source

pub fn field_lte(name: impl Into<String>, value: i64) -> Self

Numeric comparison: field <= value

Source§

impl QueryBuilder

Source

pub fn all(conditions: Vec<QueryBuilder>) -> Self

Static constructor: AND of multiple conditions

Source

pub fn any(conditions: Vec<QueryBuilder>) -> Self

Static constructor: OR of multiple conditions

Source

pub fn and(self, other: QueryBuilder) -> Self

Chainable: combine with AND

Source

pub fn or(self, other: QueryBuilder) -> Self

Chainable: combine with OR

Source

pub fn and_not(self, other: QueryBuilder) -> Self

Chainable: combine with AND NOT

Source

pub fn negate(builder: QueryBuilder) -> Self

Static constructor: negate expression

Named negate to avoid confusion with std::ops::Not::not. Use this to create NOT <expr> conditions.

Source§

impl QueryBuilder

Source

pub fn build(self) -> Result<Arc<QueryAST>, BuildError>

Build the query with default field registry validation

§Errors

Returns BuildError if:

  • Unknown field names are used
  • Operators are incompatible with field types
  • Value types don’t match field types
  • Enum values are invalid
  • Regex patterns are syntactically invalid
  • The query is empty (no conditions)
Source

pub fn build_with_registry( self, registry: &FieldRegistry, ) -> Result<Arc<QueryAST>, BuildError>

Build with custom field registry (for plugin fields)

This allows validation against a registry that includes plugin-specific fields in addition to core fields.

§Errors

Same as build().

Trait Implementations§

Source§

impl Clone for QueryBuilder

Source§

fn clone(&self) -> QueryBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryBuilder

Source§

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

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

impl Default for QueryBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> 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<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
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