Crate graphforge_core 

GraphForge shared identities, values, options, and facade errors.

Compiler, execution, storage, and domain crates consume these shared contracts. Independent utility crates can define their own types without depending on core. The public engine facade lives in graphforge-api, above the pipeline crates. Stage and transport crates retain dedicated error types; relevant boundaries classify errors for the facade and bindings.

Modules

algorithms

Typed registry and stable logical result schemas for analyst algorithms.

canonical

Shared graphforge-canonical/1 envelope and byte primitives.

embedding_options

Closed typed options for the four embedding-v1 analysis algorithms.

hash_observation

Optional process-wide SHA-256 work observation for engine diagnostics. SHA-256 with byte and elapsed-time observation during explicit captures.

identifier

Canonical graph identifier contract shared by every Rust surface.

manifest

Project manifest (graphforge.yaml) — the entry point that describes a GraphForge project directory: its identity, ontology mode, and which capabilities are enabled.

portable

Neutral portable package contracts. Neutral portable package contracts and sanitized lifecycle errors.

storage_receipt

Identity-free public storage receipts. Passive identity-free storage receipt contracts and arithmetic validation.

uuid

UUID generation, deterministic derivation, and Arrow/Parquet serialisation helpers.

Structs

AnalyzeOptions

Options for GraphForge::analyze.

BindError

A semantic error or warning produced by the binder.

ClusterOptions

Options for GraphForge::cluster.

EdgeHandle

Opaque handle to an edge created via GraphForge::add_edge.

FindOptions

Options for GraphForge::find.

NodeHandle

Opaque UUID handle to a node created by one GraphForge instance.

PageRankOptions

PageRank semantics. Omitted iterations use the existing convergence rule.

ParseError

A structured parse error produced by graphforge-cypher.

PathsOptions

Options for GraphForge::paths.

PropId

Opaque integer identifier for a property type.

RankOptions

Options for GraphForge::rank.

SimilarOptions

Options for GraphForge::similar.

Span

Byte-offset range in the original source text.

SpatialType

Complete homogeneous spatial property type.

SpatialValue

One canonical typed spatial property value.

SynchronousLabelPropagationOptions

Deterministic synchronous label propagation, separate from the default asynchronous community optimizer. Returned labels are never renumbered.

TypeId

Opaque integer identifier for any ontology type (entity, relation, or property).

Enums

AlgorithmError

Structured failures produced by Rust algorithm dispatch.

ApiErrorCode

Stable non-project knowledge/epistemic API error codes.

BindErrorKind

The kind of a binder error.

ClusteringNormalization

Definition of the local clustering coefficient.

ExplainStage

Which compiler stage to inspect through graphforge_api::GraphForge::explain_stage.

GfError

Shared error classifications used by the engine facade and bindings.

LoweringError

Errors that can occur when lowering an IR expression to DataFusion.

NodeSelector

Typed public node identity accepted by path algorithms.

OntologyFormat

Serialisation format of an ontology definition file.

OntologyMode

How the binder resolves unknown labels, relation types, and property names.

ParseErrorKind

The kind of parse error.

ProjectErrorCode

Stable project-format and project-generation error codes.

PropValue

A graph property value.

SpatialCoordinates

Canonical f64 coordinate payload for one spatial property value.

SpatialCrs

Coordinate reference systems certified by GraphForge’s spatial v1 profile.

SpatialGeometryType

Homogeneous geometry kinds in GraphForge’s spatial v1 profile.

TemporalValue

Consumer-neutral temporal values accepted at GraphForge data boundaries.

UnsupportedCypherFeature

A specific unsupported Cypher construct, shared by compiler diagnostics.