Skip to main content

Crate morphir_workspace

Crate morphir_workspace 

Source
Expand description

Portable protocol types for Morphir workspace discovery.

Modules§

config
Pure configuration candidate discovery over a portable file tree.

Structs§

DiscoveryFailure
A fatal, provider-neutral workspace discovery failure.
DiscoveryRequest
A complete, provider-independent request for workspace discovery.
FileTree
A deterministic collection of canonical paths and their entries.
ProjectSnapshot
A deterministic, provider-neutral snapshot of a project.
RelativePath
A canonical slash-separated path confined beneath a named mount.
SourceSelection
Which sources a request selects, and the root they are measured from.
Version
SemVer version as defined by https://semver.org.
WorkspaceDiagnostic
A provider-neutral diagnostic emitted during workspace discovery.
WorkspaceDiscoveryDetails
In-memory discovery details for native hosts that need the exact effective configuration values produced by the portable discovery pass.
WorkspaceSnapshot
A deterministic, provider-neutral snapshot of a workspace.

Enums§

DiagnosticSeverity
The severity of a workspace discovery diagnostic.
DiscoveryPurpose
What a discovery request is asking for.
DiscoveryResponse
The provider-neutral result of workspace discovery.
FileEntry
An entry in a portable, root-confined file tree.
ProjectOrigin
Where a discovered project came from.
ProjectSource
Where a request’s project identity comes from.
ProjectState
The state of a discovered project.
RelativePathError
An error returned when a path is not confined to its named mount.
WorkspaceState
The state of a discovered workspace.

Constants§

WORKSPACE_CONFIG_AMBIGUOUS
Stable diagnostic code for ambiguous workspace configurations.
WORKSPACE_CONFIG_INVALID
Stable diagnostic code for an invalid workspace configuration.
WORKSPACE_CONFIG_MISSING
Stable diagnostic code for a missing workspace configuration.
WORKSPACE_DISCOVERY_PROTOCOL
The workspace discovery protocol version this build writes.
WORKSPACE_LANGUAGE_ID_EMPTY
Stable diagnostic code for an ad-hoc request with an empty language id.
WORKSPACE_MEMBER_DUPLICATE_NAME
Stable diagnostic code for duplicate workspace member names.
WORKSPACE_MEMBER_INVALID
Stable diagnostic code for an invalid workspace member.
WORKSPACE_PATH_NOT_CONFINED
Stable diagnostic code for a path that escapes its named mount.
WORKSPACE_PROJECT_NAME_EMPTY
Stable diagnostic code for an explicit CLI overlay project name that is empty or whitespace-only.
WORKSPACE_PROJECT_NAME_INVALID
Stable diagnostic code for an explicit project name that the selected provider’s package contract rejects.
WORKSPACE_PROTOCOL_UNSUPPORTED
Stable diagnostic code for an unsupported discovery protocol version.
WORKSPACE_PURPOSE_UNSUPPORTED
Stable diagnostic code for a discovery purpose this build does not implement.
WORKSPACE_SELECTION_DUPLICATE
Stable diagnostic code for an ad-hoc source selection with a repeated path.
WORKSPACE_SELECTION_EMPTY
Stable diagnostic code for an ad-hoc source selection with no paths.
WORKSPACE_SELECTION_INVALID
Stable diagnostic code for an ad-hoc selected path that is not a file.
WORKSPACE_SELECTION_MODULE_COLLISION
Stable diagnostic code for two selected sources that a provider derives the same module name from.
WORKSPACE_SELECTION_NAME_REQUIRED
Stable diagnostic code for an unnamed ad-hoc selection that selects more than one source, and therefore has nothing a provider could derive a name from.
WORKSPACE_SELECTION_OUTSIDE_ROOT
Stable diagnostic code for an ad-hoc selected path outside its selection root.
WORKSPACE_SYMLINK_UNSUPPORTED
Stable diagnostic code for a symlink that a protocol-v1 host did not materialize.

Traits§

SourceIdentity
How one language turns selected sources into package and module identity.

Functions§

discover
Discovers a Morphir workspace from portable, root-confined inputs.
discover_with_details
Discovers a workspace and returns the exact merged configuration values produced by the same pass as discover.
discover_with_identity
Discovers a workspace and completes an ad-hoc project with identity.
speaks_workspace_discovery_protocol
Whether this build speaks workspace discovery protocol version.
workspace_discovery_protocol
WORKSPACE_DISCOVERY_PROTOCOL as a version.