Blyx

Swallow

Workflow framework · 0.1.0

Validate an exported payload's declared spans and checksum, then locate a byte.

Verify a record table before interpreting a byte offset

The payload bytes 65 and 66 yield checksum 12976260. Offset 1 is the first byte of the second record.

Run the native CLI

Extract the workflow collection for your platform. Run .\bin\swallow.exe --help in PowerShell or ./bin/swallow --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-swallow.git
cd blyx-swallow
blyxc native-run project.blyx -- "1,1" "65,66" 1 12976260

Why this framework exists

A valid byte offset can point into the wrong serialized record if lengths have drifted. Verify the table and payload before interpreting the offset. IETF RFC 1950, Adler-32

Install Swallow in your editor

Extension RahulChaube.blyx-swallow · 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-swallow-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 Swallow.

Download the companion Blyx Language VSIX

Libraries in this framework

Install with Conda

Create an environment containing Swallow 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-swallow=0.1.0=0
blyxc native-run ./blyx-env/share/blyx/swallow/main.blyx

To use this package in your application, copy share/blyx/swallow/vendor/swallow 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-swallow.git vendor/swallow

You can also download Swallow as a ZIP. Extract its contents into vendor/swallow.

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

use vendor::swallow::swallow;

fn main() {
    let lengths = [1, 1];
    let payload = [65, 66];
    let offset = 1.0;
    let checksum = 12976260.0;
    let result = swallow_inspect(lengths, payload, offset, checksum);
    if len(result) == 0 { println!("invalid"); return; }
    let mut i = 0;
    while i < len(result) {
        println!(at(result, i));
        i += 1;
    }
}

Expected output

1
12976260
1
0

API and input requirements

Returns [checksum matches, actual Adler-32, record index, in-record offset]. The sum of payload lengths must equal the byte count. Use a verified cryptographic signature when authenticity is required. Invalid arguments and nonfinite results return an empty vector.

APIUse
swallow_inspect(lengths, payload, offset, checksum)Returns [checksum matches, actual Adler-32, record index, in-record offset]. The sum of payload lengths must equal the byte count. Use a verified cryptographic signature when authenticity is required.

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.