Struct TypeReference 

pub struct TypeReference { /* private fields */ }

Unified type reference representing any path/type usage in Rust code.

Implementations

impl TypeReference

pub fn new<I, S>(segments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Creates a new TypeReference from path segments with no prefix or suffix.

Use the builder methods (with_crate_prefix, with_alias, with_glob, etc.) to set a prefix or suffix after construction.

pub const fn with_crate_prefix(self) -> Self

Sets crate:: prefix.

pub const fn with_self_prefix(self) -> Self

Sets self:: prefix.

pub const fn with_super(self, levels: usize) -> Self

Sets super:: prefix with given level count.

pub fn with_alias(self, alias: impl Into<String>) -> Self

Sets an alias (as Name).

pub fn with_glob(self) -> Self

Marks as glob import (::*).

pub fn with_group(self, items: Vec<GroupItem>) -> Self

Sets grouped items ({A, B, C}).

pub fn segments(&self) -> &[String]

Returns the path segments.

pub const fn prefix(&self) -> PathPrefix

Returns the path prefix.

pub const fn is_relative(&self) -> bool

Returns true if this is a relative path (self::, super::, crate::).

pub fn is_from_crate(&self, crate_name: &str) -> bool

Checks if this path is from a specific crate.

pub const fn has_glob(&self) -> bool

Returns true if this has a glob.

pub const fn has_group(&self) -> bool

Returns true if this has a group.

pub fn final_name(&self) -> Option<&str>

Returns the final name (last segment or alias if present).

pub fn truncate_to_depth(&self, depth: usize) -> Self

Truncates the path to the given depth (number of segments).

If the path has more segments than depth, the segments are truncated and the suffix is dropped. Otherwise the reference is returned unchanged.

Examples

use crawk::TypeReference;

// "module::analyzer::Error" (3 segments) truncated to depth 2
// becomes "module::analyzer" (suffix dropped)
let reference = TypeReference::new(["module", "analyzer", "Error"]);
let truncated = reference.truncate_to_depth(2);
assert_eq!(truncated.to_path_string(), "module::analyzer");

pub fn to_path_string(&self) -> String

Converts to string representation.

Trait Implementations

impl Clone for TypeReference

fn clone(&self) -> TypeReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeReference

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

Formats the value using the given formatter.

impl Display for TypeReference

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

Formats the full path string, including prefix (crate::, self::, etc.), segments, and suffix (alias, glob, or group).

impl Hash for TypeReference

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 TypeReference

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

impl StructuralPartialEq for TypeReference