Class RustSourceCode

An object representing a given source code.

Hierarchy (view full)

Constructors

constructor

Properties

cargoCrate? cargoFeatures? cargoToml? cargoWorkspace? log sourceDirty? sourceOrigin? sourcePath? sourceRef?

Accessors

[toStringTag] canCompile canCompileInfo canFetch canFetchInfo

Methods

serialize

Constructors

constructor

Properties

Optional cargoCrate

cargoCrate?: string

Name of crate.

Optional cargoFeatures

cargoFeatures?: string[] | Set<string>

List of crate features to enable during build.

Optional cargoToml

cargoToml?: string

Path to the crate's Cargo.toml under sourcePath

Optional cargoWorkspace

cargoWorkspace?: string

Path to the workspace's Cargo.toml in the source tree.

log

log: Core.Console

Optional sourceDirty

sourceDirty?: boolean

Whether the code contains uncommitted changes.

Optional sourceOrigin

sourceOrigin?: string | URL

URL pointing to Git upstream containing the canonical source code.

Optional sourcePath

sourcePath?: string

Path to local checkout of the source code (with .git directory if sourceRef is set).

Optional sourceRef

sourceRef?: string

Pointer to the source commit.

Accessors

[toStringTag]

canCompile

canCompileInfo

canFetch

canFetchInfo

Methods

serialize

  • serialize(): {
        sourceDirty?: boolean;
        sourceOrigin?: string;
        sourcePath?: string;
        sourceRef?: string;
        [key: string]: unknown;
    } & {
        cargoCrate?: string;
        cargoFeatures?: string[];
        cargoWorkspace?: string;
        [key: string]: unknown;
    }

  • Returns {
        sourceDirty?: boolean;
        sourceOrigin?: string;
        sourcePath?: string;
        sourceRef?: string;
        [key: string]: unknown;
    } & {
        cargoCrate?: string;
        cargoFeatures?: string[];
        cargoWorkspace?: string;
        [key: string]: unknown;
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc