Skip to main content

DiscoveryReport

codehelion_core::discovery

Struct DiscoveryReport

pub struct DiscoveryReport {
    pub units: Vec<SourceUnit>,
    pub build_variant: BuildVariant,
    pub header_language: Language,
    pub packages: Vec<PackageInfo>,
    pub suppressed_generated: Vec<PathBuf>,
    pub skipped: SkipReport,
    pub compile_commands: Option<CompileCommands>,
    pub compile_commands_error: Option<CompileCommandsDiagnostic>,
}

Expand description

The outcome of a discovery run.

Fields§

§units: Vec<SourceUnit>

Source units selected for analysis, ordered by relative path.

§build_variant: BuildVariant

The implicit build variant every unit is attributed to.

§header_language: Language

The language bare .h headers were read as: what the configured HeaderPolicy named, or what the tree pointed to when the policy left it to detection.

§packages: Vec<PackageInfo>

Cargo packages recognised in the tree, ordered by name.

§suppressed_generated: Vec<PathBuf>

Relative paths excluded because they are generated, ordered by path.

§skipped: SkipReport

Counts of files skipped for other reasons.

§compile_commands: Option<CompileCommands>

Parsed compilation database, if one was found and read successfully.

§compile_commands_error: Option<CompileCommandsDiagnostic>

A compilation database found during discovery but not usable for semantic analysis.

Trait Implementations§

impl Clone for DiscoveryReport

fn clone(&self) -> DiscoveryReport

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for DiscoveryReport

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for DiscoveryReport

impl RefUnwindSafe for DiscoveryReport

impl Send for DiscoveryReport

impl Sync for DiscoveryReport

impl Unpin for DiscoveryReport

impl UnsafeUnpin for DiscoveryReport

impl UnwindSafe for DiscoveryReport

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.