Struct Project 

pub struct Project { /* private fields */ }

Represents a .NET project.

Implementations

impl Project

pub fn new<P>(path: P) -> Result<Self, ParseError>

where P: AsRef<Path>,

Creates a new Project instance by parsing a .NET project file.

This function opens the file specified by the path, reads its contents, and parses it into a Project instance using the parser::parse function.

Arguments

• path - A path to the .NET project file that implements the AsRef<Path> trait.

Returns

A Result<Self, ParseError> where Ok(Self) contains the parsed Project instance, and Err(ParseError) contains the error if the file could not be read or parsed.

Errors

This function will return an error if:

• The file could not be opened.
• The file could not be parsed as a .NET project file.

Examples

use dotnet_lens::{Project, parser::ParseError};
use std::path::Path;

match Project::new(Path::new("path/to/MyProject.csproj")) {
    Ok(project) => {
        println!("Project parsed successfully: {:?}", project);
    },
    Err(e) => {
        eprintln!("Failed to parse project: {:?}", e);
    }
}

pub fn get_project_name<P>(path: P) -> Option<String>

where P: AsRef<Path>,

Returns the name of the project based on the file name of the provided path.

Arguments

• path - A reference to a path that implements the AsRef<Path> trait.

Returns

An Option<String> containing the project name if it could be extracted, otherwise None.

pub fn name(&self) -> &String

Returns the name of the project.

pub fn language(&self) -> ProjectLanguage

Returns the language of the project.

pub fn path(&self) -> &PathBuf

Returns the path of the project.

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

Returns the target framework of the project, if any.

pub fn project_references(&self) -> &Vec<ProjectReference>

Returns a reference to the list of project references.

pub fn add_project_reference(&mut self, value: ProjectReference)

Adds a new project reference to the list of project references.

pub fn package_references(&self) -> &Vec<PackageReference>

Returns a reference to the list of package references.

pub fn add_package_reference(&mut self, value: PackageReference)

Adds a new package reference to the list of package references.

Trait Implementations

impl Clone for Project

fn clone(&self) -> Project

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Project

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

Formats the value using the given formatter.

impl PartialEq for Project

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