Skip to main content

Crate refeff

Crate refeff 

Source
Expand description

Typed programmatic facade for the FEFF10-compatible Rust pipeline.

Runner::run_files is the stable file-backed entry point. Numerical kernels and format codecs remain available from refeff-core and refeff-io; CLI parsing is deliberately absent from this API.

Re-exports§

pub use refeff_core as core;
pub use refeff_io as io;

Modules§

prelude
Common facade imports for applications embedding FEFF.

Structs§

ArtifactRef
Borrowed view of one in-memory FEFF file.
ArtifactSet
An owned collection of relative FEFF workspace files.
CancellationToken
A cloneable cancellation handle. Cancellation is permanent for this token.
Diagnostic
Non-fatal diagnostic produced during a run.
FileRunRequest
File-backed pipeline request.
FormatDescriptor
Static metadata for a registered FEFF format.
MemoryRunRequest
Request for a file-compatible run backed by memory rather than a caller managed directory.
MemoryRunResult
Result of an in-memory run.
NumericTolerance
Numeric comparison envelope for a decoded format.
RunReport
Typed summary of a completed file-backed run.
Runner
Configurable FEFF pipeline runner.
Spectra
Decoded final EXAFS spectra. Files and raw path amplitudes remain available separately; these tables represent the assembled spectrum.
StageReport
Report for one completed stage.

Enums§

ArtifactSelection
Choose which workspace payloads an in-memory run returns. Intermediate stage serialization is still required by the compatibility scheduler.
Error
Errors returned by the typed runner boundary.
ExistingOutputPolicy
Policy for files already present in a run’s output directory.
FileFormat
Stable identifier for a FEFF-compatible file format.
Interrupted
Why a calculation stopped cooperatively.
Module
FEFF pipeline stages exposed to programmatic callers.
ProgressEvent
Progress event sent to a library callback.
Representation
Physical representation used by a FEFF format.
StageAction
Whether a completed stage reused or generated artifacts.

Traits§

FeffCodec
Codec implemented by typed FEFF input/output models.
ProgressSink
Callback for observing long-running work without coupling the library to a logging framework.

Functions§

identify_format
Identify a known FEFF format from its basename.

Type Aliases§

Result
Result alias for facade operations.