Skip to main content

Project

Struct Project 

Source
pub struct Project { /* private fields */ }
Expand description

A project loaded entirely in memory as PureFile ASTs.

This is a pure data container with I/O capabilities. For transformations, use ryo-executor::Workspace. For searching, use ryo-analysis::DiscoveryEngine.

§Fields

  • config_root: Location of ryo.toml (or where it would be)
  • metadata: Cargo workspace metadata (crate info, paths)
  • config: Project configuration from ryo.toml
  • files: Loaded source files

Implementations§

Source§

impl Project

Source

pub fn load(path: impl AsRef<Path>) -> Result<Self, ProjectError>

Load a project from disk

§Workflow
  1. Look for ryo.toml in the given directory
  2. Determine Cargo.toml location from config or auto-detect
  3. Create CargoMetadataProvider for workspace info
  4. Load files by traversing mod declarations from entry points
§Arguments
  • path - Directory containing the project (with or without ryo.toml)
Source

pub fn config_root(&self) -> &Path

Get the config root (where ryo.toml is or would be)

Source

pub fn workspace_root(&self) -> &Path

Get the workspace root (from Cargo metadata)

Source

pub fn root(&self) -> &Path

Get the root path (alias for workspace_root for backward compatibility)

Source

pub fn metadata(&self) -> &CargoMetadataProvider

Get the Cargo metadata provider

Source

pub fn config(&self) -> &RyoConfig

Get the project configuration

Source

pub fn path_resolver(&self) -> WorkspacePathResolver

Create a WorkspacePathResolver for this project

Uses workspace type from CargoMetadataProvider to correctly validate crate:: paths (ambiguous in multi-crate workspaces).

Source

pub fn file_paths(&self) -> impl Iterator<Item = &PathBuf>

Get all file paths

Source

pub fn files(&self) -> &HashMap<PathBuf, PureFile>

Get all files

Source

pub fn files_mut(&mut self) -> &mut HashMap<PathBuf, PureFile>

Get mutable access to files

Source

pub fn file_count(&self) -> usize

Number of files loaded

Source

pub fn resolve_path(&self, path: &Path) -> Option<PathBuf>

Resolve a path to the actual key in the files HashMap. Handles both relative and absolute paths.

Source

pub fn get_file(&self, path: &Path) -> Option<&PureFile>

Get a file by path

Source

pub fn get_file_mut(&mut self, path: &Path) -> Option<&mut PureFile>

Get a mutable file by path

Source

pub fn insert_file(&mut self, path: PathBuf, file: PureFile)

Insert or update a file

Source

pub fn get_file_with_path(&self, path: &Path) -> Option<(PathBuf, &PureFile)>

Get a file and its resolved path

Source

pub fn get_file_mut_with_path( &mut self, path: &Path, ) -> Option<(PathBuf, &mut PureFile)>

Get a mutable file and its resolved path

Source

pub fn contains_file(&self, path: &Path) -> bool

Check if a file exists

Source

pub fn get_source(&self, path: &Path) -> Result<Option<String>, ProjectError>

Get generated source for a file

Source

pub fn write_to_disk(&self, paths: &[PathBuf]) -> Result<usize, ProjectError>

Write modified files back to disk

Creates parent directories if they don’t exist (for newly created files).

Source

pub fn write_all_to_disk(&self) -> Result<usize, ProjectError>

Write all files to disk

Source

pub fn load_files( root: impl AsRef<Path>, ) -> Result<HashMap<PathBuf, PureFile>, ProjectError>

Load files from a project directory without creating a Project instance.

This is the preferred method for the Context-centric design where AnalysisContext is the Single Source of Truth for file content.

§Example
let files = Project::load_files("/path/to/project")?;
let context = AnalysisContext::from_path_files(files, "crate");
Source

pub fn write_from_context( &self, ctx: &AnalysisContext, files: &[WorkspaceFilePath], ) -> Result<usize, ProjectError>

Write modified files from an AnalysisContext to disk.

§Arguments
  • ctx - The AnalysisContext containing the modified files
  • files - The WorkspaceFilePaths of the files to write
§Returns

The number of files successfully written to disk.

Source

pub fn sync_from_context( &mut self, ctx: &AnalysisContext, files: &[WorkspaceFilePath], )

Sync modified files from Context back to Project.files.

Maintains backward compatibility for code that still reads from Project.files.

Auto Trait Implementations§

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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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