Fuel

Description

Fuel, the Smalltalk object serializer

Details

Source
GitHub
Dialect
pharo (40% confidence)
License
MIT
Stars
29
Forks
14
Created
March 24, 2015
Updated
Nov. 1, 2025
Topics
pharo serializer smalltalk squeak

Categories

Serialization

README excerpt

 ![Fuel](resources/logo-fuel-header.png)

- [Description](#description)
- [Properties](#properties)
- [Installation](#installation)
- [Report bugs](#report-bugs)
- [More documentation](#more-documentation)
# Description
A general-purpose object serialization framework developed in [Pharo](https://pharo.org). Fuel is developed under the [MIT license](http://www.opensource.org/licenses/mit-license.php).
##### Concrete
We don't aspire to have a dialect-interchange format. This enables us to serialize special objects like contexts, block closures, exceptions, compiled methods and classes. Although there are ports to other dialects, Fuel development is Pharo-centric.
##### Flexible
Depending on the context, there could be multiple ways of serializing the same object. For example, a class can be considered either a global or a regular object. In the former case, it will be encoded just its name; in the latter case, the class will be encoded in detail, with its method dictionary, etc.
##### Fast
We worry about to have the best performance. We developed a complete benchmark suite to help analyse the performance with diverse sample sets, as well as compare against other serializers. Our pickling algorithm allows outstanding materialization performance, as well as very good serialization performance too.
##### Object-Oriented Design
From the beginning it was a constraint to have a good object-oriented design and to do not need any special support from the VM. In addition, Fuel has a complete test suite, with a high coverage. We also worry about writing comments on classes and methods.

# Projects using Fuel
We would love to see your project here too ;)!
- [Pharo](http://pharo.org): Fuel comes baked into Pharo
- [Snapdump](https://github.com/zweidenker/snapdump): Create and manage runtime snapshots in Pharo
- [Computer-World](https://github.com/seandenigris/Computer-World): Make computing objects come alive
- [Resources-Live](https://github.com/seandenigris/Resources-Live): Not files, live resources!
- [SimplePersistence](https://github.com/seandenigris/Simple-Persistence): Hassle free model backups
- [Launchpad](https://github.com/ba-st/Launchpad): Application entry point command line handler template for Pharo

# Status of automated builds
### Pharo

[![Build status: Pharo 14 (alpha)](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-14.0.yaml?branch=Pharo14&label=Pharo%2014%20(alpha)&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-14.0.yaml)
[![Build status: Pharo 13](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-13.0.yaml?branch=Pharo13&label=Pharo%201&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-13.0.yaml)
[![Build status: Pharo 12](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-12.0.yaml?branch=Pharo12&label=Pharo%2012&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-12.0.yaml)

master | 5.2.2 | 5.1.0 | 5.0.6 | 4.1.1 | 3.0.4 | 3.0.3 |
 ------------ | ------------ | ------------ | ------------ | ------------ | ------------ | ------------- |
[![Build status: Pharo 11.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-11.0.yaml?branch=master&label=11.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-11.0.yaml) | [![Build status: Pharo 11.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-11.0.yaml?branch=5.2.2&label=11.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-11.0.yaml) | - | - | - | - | - |
[![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=master&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=5.2.2&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=5.1.0&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=5.0.6&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=4.1.1&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=3.0.4&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) | [![Build status: Pharo 10.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-10.0.yaml?branch=3.0.3&label=10.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-10.0.yaml) |
[![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=master&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=5.2.2&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=5.1.0&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=5.0.6&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=4.1.1&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=3.0.4&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) | [![Build status: Pharo 9.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-9.0.yaml?branch=3.0.3&label=9.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-9.0.yaml) |
[![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=master&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=5.2.2&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=5.1.0&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=5.0.6&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=4.1.1&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=3.0.4&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) | [![Build status: Pharo 8.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-8.0.yaml?branch=3.0.3&label=8.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-8.0.yaml) |
[![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=master&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=5.2.2&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=5.1.0&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=5.0.6&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=4.1.1&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=3.0.4&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) | [![Build status: Pharo 7.0](https://img.shields.io/github/actions/workflow/status/theseion/fuel/pharo-7.0.yaml?branch=3.0.3&label=7.0&logo=github)](https://github.com/theseion/Fuel/actions/workflows/pharo-7.0.yaml) |

### Squeak
master | 5.2.2 | 5.1.0 | 5.0.6 | 4.1.1 | 3.0.4 | 3.0.3 |
------------- | ------------- | ------------- | ------------- | ----------- | ------------ | ------------- |
[![Build status: Squeak alpha](https://img.shields.io/github/actions/workflow/status/theseion/fuel/squeak-alpha.
← Back to results