Enum RelationKind 

pub enum RelationKind {
    Callers,
    Callees,
    Imports,
    Exports,
    Returns,
}

Types of symbol relationships for relation queries.

Used by the relation_query tool/command to specify which relationships to traverse from a given symbol.

Serialization

All variants serialize to lowercase: "callers", "callees", etc.

Examples

use sqry_core::schema::RelationKind;

let kind = RelationKind::Callers;
assert_eq!(kind.as_str(), "callers");

let parsed = RelationKind::parse("callees").unwrap();
assert_eq!(parsed, RelationKind::Callees);

Variants

Callers

Find symbols that call the target symbol.

Traverses incoming Calls edges in the graph.

Callees

Find symbols that the target symbol calls.

Traverses outgoing Calls edges in the graph.

Imports

Find symbols imported by the target symbol/file.

Traverses Imports edges in the graph.

Exports

Find symbols exported by the target symbol/file.

Traverses Exports edges in the graph.

Returns

Find return type relationships.

Traverses TypeOf edges where the source is a function/method.

Implementations

impl RelationKind

pub const fn all() -> &'static [Self]

Returns all variants in definition order.

pub const fn as_str(self) -> &'static str

Returns the canonical string representation.

pub fn parse(s: &str) -> Option<Self>

Parses a string into a RelationKind.

Returns None if the string doesn’t match any known kind. Case-insensitive.

pub const fn is_call_relation(self) -> bool

Returns true if this relation traverses call edges.

pub const fn is_boundary_relation(self) -> bool

Returns true if this relation traverses import/export edges.

Trait Implementations

impl Clone for RelationKind

fn clone(&self) -> RelationKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationKind

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

Formats the value using the given formatter.

impl Default for RelationKind

fn default() -> RelationKind

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RelationKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RelationKind

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

Formats the value using the given formatter.

impl Hash for RelationKind

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 RelationKind

fn eq(&self, other: &RelationKind) -> 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 RelationKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RelationKind

impl Eq for RelationKind

impl StructuralPartialEq for RelationKind