Blyx

Sanderling

Workflow framework · 0.1.0

Choose a cache serving mode from stored age, local elapsed time and grace policy.

Carry cache age across a local storage interval

An entry stored at age eight reaches age thirteen after five more ticks. Three ticks of its stale-serving grace remain.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\sanderling.exe --help in PowerShell or ./bin/sanderling --help on Linux and macOS. Running the command with no arguments prints the worked example.

Build from source

With Blyx 0.2.1, Rust and a host linker installed, run these commands to edit and rebuild the example.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-sanderling.git
cd blyx-sanderling
blyxc native-run project.blyx -- 8 100 105 10 6 0

Why this framework exists

Starting freshness at zero on every cache hop can keep stale content alive. Carry the stored age forward before applying grace. IETF RFC 9111, freshness

Install Sanderling in your editor

Extension RahulChaube.blyx-sanderling · 0.1.0

The extension includes a runnable Blyx example, function completions and the framework source. For the modular project, extract the starter, open its folder and run blyxc native-run main.blyx with the native toolchain installed.

Create an empty .blyx file, type blyx-sanderling-demo and accept the completion. Choose Blyx: Run File to run the example.

For an offline installation, choose Extensions: Install from VSIX for Blyx Language first, then for Sanderling.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Sanderling 0.1.0, its Blyx source and a runnable example. Run the second command with Blyx 0.2.1, Rust and a host linker installed.

conda create -y --prefix ./blyx-env --override-channels -c https://rahulchaube1.github.io/blyx-packages blyx-sanderling=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/sanderling/main.blyx

To use this package in your application, copy share/blyx/sanderling/vendor/sanderling from the environment into your project's vendor directory.

Install the full collection with Homebrew or Scoop

Import into a Blyx project

Install Blyx 0.2.1, Rust 1.85 or newer and a host linker. From the directory containing your entry file, clone this tagged release.

git clone --depth 1 --branch v0.1.0 https://github.com/Rahulchaube1/blyx-sanderling.git vendor/sanderling

You can also download Sanderling as a ZIP. Extract its contents into vendor/sanderling.

Save this as main.blyx beside vendor and run blyxc native-run main.blyx.

use vendor::sanderling::sanderling;

fn main() {
    let age_at_store = 8.0;
    let stored = 100.0;
    let now = 105.0;
    let lifetime = 10.0;
    let grace = 6.0;
    let mandatory = 0.0;
    let result = sanderling_lookup(age_at_store, stored, now, lifetime, grace, mandatory);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

1
13
3

API and input requirements

Returns [mode, current age, ticks until mode changes]. Mode 0 serves fresh, 1 serves under explicit stale grace, and 2 requires validation. The host parses and enforces other cache directives. Invalid arguments and nonfinite results return an empty vector.

APIUse
sanderling_lookup(age_at_store, stored, now, lifetime, grace, mandatory)Returns [mode, current age, ticks until mode changes]. Mode 0 serves fresh, 1 serves under explicit stale grace, and 2 requires validation. The host parses and enforces other cache directives.

Develop and contribute

Open the tagged source to read the implementation and examples. Include the smallest reproducible Blyx program, compiler version and expected result when reporting an issue.