Struct CrateInterfaceItem

pub struct CrateInterfaceItem<T>
where
    T: GenerateSignature,
{ /* private fields */ }

A single top-level item (fn, struct, etc.), with docs, attributes, and an optional body.

T must implement GenerateSignature so we can produce something like fn name() or struct Name for display.

Important: We store two ranges:

1. raw_syntax_range: the full range from RA’s syntax node (this exactly matches node.syntax().text_range()).
2. effective_item_range: a trimmed range that excludes leading/trailing normal comments and whitespace (but keeps doc comments). We use this for computing interstitial segments.

Many tests (like test_text_range in your suite) compare raw_syntax_range to the node’s actual text_range() to confirm no mismatch. Meanwhile, the interstitial logic uses effective_item_range to ensure normal line/block comments on the edges appear in interstitial segments instead of being “inside” the item.

Implementations

impl<T> CrateInterfaceItem<T>

where T: GenerateSignature,

pub fn set_item(&mut self, val: Arc<T>) -> &mut CrateInterfaceItem<T>

pub fn set_docs(&mut self, val: Option<String>) -> &mut CrateInterfaceItem<T>

pub fn set_attributes( &mut self, val: Option<String>, ) -> &mut CrateInterfaceItem<T>

pub fn set_body_source( &mut self, val: Option<String>, ) -> &mut CrateInterfaceItem<T>

pub fn set_consolidation_options( &mut self, val: Option<ConsolidationOptions>, ) -> &mut CrateInterfaceItem<T>

pub fn set_file_path(&mut self, val: PathBuf) -> &mut CrateInterfaceItem<T>

The file path from which this item was parsed

pub fn set_crate_path(&mut self, val: PathBuf) -> &mut CrateInterfaceItem<T>

The crate root path for the crate that owns this item

pub fn set_raw_syntax_range( &mut self, val: TextRange, ) -> &mut CrateInterfaceItem<T>

The full syntax node range, exactly matching RA’s node range. Many tests expect this to match node.text_range().

pub fn set_effective_item_range( &mut self, val: TextRange, ) -> &mut CrateInterfaceItem<T>

A trimmed range that excludes leading/trailing normal line comments, block comments, and whitespace—but keeps doc comments. We use this for interstitial segment calculations, so “normal” comments appear in the leftover text.

impl<T> CrateInterfaceItem<T>

where T: GenerateSignature,

pub fn item(&self) -> &Arc<T>

pub fn docs(&self) -> &Option<String>

pub fn attributes(&self) -> &Option<String>

pub fn body_source(&self) -> &Option<String>

pub fn consolidation_options(&self) -> &Option<ConsolidationOptions>

pub fn file_path(&self) -> &PathBuf

The file path from which this item was parsed

pub fn crate_path(&self) -> &PathBuf

The crate root path for the crate that owns this item

pub fn raw_syntax_range(&self) -> &TextRange

The full syntax node range, exactly matching RA’s node range. Many tests expect this to match node.text_range().

pub fn effective_item_range(&self) -> &TextRange

A trimmed range that excludes leading/trailing normal line comments, block comments, and whitespace—but keeps doc comments. We use this for interstitial segment calculations, so “normal” comments appear in the leftover text.

impl<T> CrateInterfaceItem<T>

where T: GenerateSignature,

pub fn new_with_paths_and_ranges( item: T, docs: Option<String>, attributes: Option<String>, body_source: Option<String>, consolidation_options: Option<ConsolidationOptions>, file_path: PathBuf, crate_path: PathBuf, raw_syntax_range: TextRange, effective_item_range: TextRange, ) -> CrateInterfaceItem<T>

Creates a new CrateInterfaceItem with both a raw_syntax_range and an effective_item_range. Usually:

• raw_syntax_range = exactly the RA node’s text_range().
• effective_item_range = maybe the same as raw_syntax_range or a “trimmed” version that excludes normal (non-doc) line/block comments from edges.

impl<T> CrateInterfaceItem<T>

where T: GenerateSignature,

pub fn text_range(&self) -> &TextRange

This is the “official” accessor for the RA node range, used by test_text_range etc. We do not trim comments here.

So if you need the untrimmed range to compare with RA, call ci.raw_syntax_range().

If you want the trimmed range for interstitial logic, call ci.effective_item_range().

pub fn effective_range(&self) -> &TextRange

This is the accessor for the “trimmed” range that excludes normal line comments at the edges. Interstitial logic uses this one to unify coverage.

Trait Implementations

impl<T> Clone for CrateInterfaceItem<T>

where T: Clone + GenerateSignature,

fn clone(&self) -> CrateInterfaceItem<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CrateInterfaceItem<T>

where T: Debug + GenerateSignature,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for CrateInterfaceItem<T>

where T: RehydrateFromSignature,

fn deserialize<D>( deserializer: D, ) -> Result<CrateInterfaceItem<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for CrateInterfaceItem<T>

where T: GenerateSignature + MaybeHasSyntaxKind,

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

Formats the value using the given formatter.

impl<T> Serialize for CrateInterfaceItem<T>

where T: RehydrateFromSignature,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Send for CrateInterfaceItem<T>

where T: GenerateSignature,

impl<T> Sync for CrateInterfaceItem<T>

where T: GenerateSignature,