Skip to main content

ParseContext

Struct ParseContext 

Source
#[non_exhaustive]
pub struct ParseContext<'a> { pub source: &'a str, pub session_id: &'a str, pub query_type: QueryType, pub params: &'a [(SmolStr, ScalarValue)], }
Expand description

Parse-phase context.

query_type defaults to QueryType::Cypher for back-compat with hooks built against the v1.0 shape; populate via Self::with_query_type when the host knows the language up front. params defaults to an empty slice; populate via Self::with_params to surface bound query parameters to hooks (Arrow-shaped to keep uni-plugin free of any uni-common dep).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§source: &'a str

Raw source text of the query.

§session_id: &'a str

Session identifier.

§query_type: QueryType

Query language classification (v1.1).

§params: &'a [(SmolStr, ScalarValue)]

Bound query parameters as (name, value) pairs (v1.1).

Implementations§

Source§

impl<'a> ParseContext<'a>

Source

pub fn new(source: &'a str, session_id: &'a str) -> Self

Construct a parse context with defaults for the v1.1 fields.

Hooks built outside of uni-plugin use this constructor; the struct is #[non_exhaustive] so direct struct-literal construction is forbidden. query_type defaults to QueryType::Cypher; params defaults to an empty slice. Override via the builders below.

Source

pub fn with_query_type(self, query_type: QueryType) -> Self

Override the query-language classification.

Source

pub fn with_params(self, params: &'a [(SmolStr, ScalarValue)]) -> Self

Attach a borrowed slice of bound query parameters.

Trait Implementations§

Source§

impl<'a> Debug for ParseContext<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ParseContext<'a>

§

impl<'a> !UnwindSafe for ParseContext<'a>

§

impl<'a> Freeze for ParseContext<'a>

§

impl<'a> Send for ParseContext<'a>

§

impl<'a> Sync for ParseContext<'a>

§

impl<'a> Unpin for ParseContext<'a>

§

impl<'a> UnsafeUnpin for ParseContext<'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<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> 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> PluginState for T
where T: Send + Sync + 'static,

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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