Struct QName 

pub struct QName { /* private fields */ }

Qualified plugin item name — namespace.local.

QName is the address every plugin-registered extension is looked up by. The namespace is the registering plugin’s id; the local is the per-plugin item name. Built-ins use the reserved namespace QName::BUILTIN_NS.

Examples

use uni_plugin::QName;
let q = QName::parse("ai.dragonscale.geo.haversine").unwrap();
assert_eq!(q.namespace(), "ai.dragonscale.geo");
assert_eq!(q.local(), "haversine");

Errors

QName::parse returns PluginError::InvalidQName if the input does not contain at least one . separating namespace from local, or if either side is empty.

Implementations

impl QName

pub const BUILTIN_NS: &'static str = "builtin"

Reserved namespace for uni-db built-in extensions.

Built-ins registered by uni-plugin-builtin use this namespace so they are distinguishable from third-party plugins at the registry level. The user-facing Cypher / Locy syntax does not require the namespace prefix for built-ins — RETURN toUpper(s) resolves to builtin.toUpper through Cypher’s case-insensitive matching.

pub fn new(namespace: impl Into<SmolStr>, local: impl Into<SmolStr>) -> Self

Construct a QName from already-validated parts.

Panics

Panics if namespace or local is empty, since this is a programming error rather than a fallible parse — use QName::parse to validate untrusted input.

pub fn builtin(local: impl Into<SmolStr>) -> Self

Construct a QName in the QName::BUILTIN_NS namespace.

Shorthand for built-in registrations.

Examples

use uni_plugin::QName;
let q = QName::builtin("MIN");
assert_eq!(q.namespace(), "builtin");
assert_eq!(q.local(), "MIN");

pub fn parse(s: impl AsRef<str>) -> Result<Self, PluginError>

Parse a fully-qualified name like "ai.dragonscale.geo.haversine".

The last segment (after the final .) is taken as the local name; the preceding segments are joined back as the namespace. A namespace with no . (e.g. "builtin.MIN") is also accepted.

Errors

Returns PluginError::InvalidQName if the input lacks a ., or if either side of the final . is empty.

pub fn namespace(&self) -> &str

Returns the namespace portion (the plugin id).

pub fn local(&self) -> &str

Returns the local portion (the per-plugin item name).

pub fn is_builtin(&self) -> bool

Returns true if this name is in the reserved built-in namespace.

pub fn matches_cypher(&self, other: &Self) -> bool

Cypher-style case-insensitive equality.

Cypher function-call sites compare names case-insensitively (toUpper and TOUPPER resolve identically). Locy uses PartialEq (case-sensitive) directly.

Trait Implementations

impl Clone for QName

fn clone(&self) -> QName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for QName

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

Formats the value using the given formatter.

impl Eq for QName

impl FromStr for QName

type Err = PluginError

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.

impl Hash for QName

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for QName

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

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

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 QName

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QName