Cortex Data Framework is a robust, extensible platform designed to facilitate real-time data streaming, processing, and state management. It provides developers with a comprehensive suite of tools and libraries to build scalable, high-performance data pipelines tailored to diverse use cases. By abstracting underlying streaming technologies and state management solutions, Cortex Data Framework enables seamless integration, simplified development workflows, and enhanced maintainability for complex data-driven applications.
using Cortex.Serialization.Yaml.Serialization;
using Cortex.Serialization.Yaml.Serialization.Conventions;
public sealed record Address(string Street, string City);
public sealed class Person
{
public string FirstName { get; set; } = string.Empty;
public string LastName { get; set; } = string.Empty;
public int Age { get; set; }
public List<string> Tags { get; set; } = new();
public Address? Address { get; set; }
}
var person = new Person
{
FirstName = "Ada",
LastName = "Lovelace",
Age = 36,
Tags = ["math", "poet"],
Address = new("12 St James's Sq", "London")
};
var serializer = new YamlSerializer(new YamlSerializerSettings
{
NamingConvention = new SnakeCaseConvention(),
EmitNulls = false
});
string yaml = serializer.Serialize(person);
Console.WriteLine(yaml);
var deserializer = new YamlDeserializer(new YamlDeserializerSettings
{
NamingConvention = new SnakeCaseConvention()
});
var model = deserializer.Deserialize<Person>(yaml);
Console.WriteLine($"Hello {model.FirstName} {model.LastName}, {model.Age}");
🔧 Configuration & Options
Serializer settings
var settings = new YamlSerializerSettings
{
NamingConvention = new CamelCaseConvention(), // how CLR names map to YAML keys
EmitNulls = true, // include null properties
EmitDefaults = true, // include default(T) values
SortProperties = false, // keep reflection order
Indentation = 2, // spaces per indent level
PreferFlowStyle = false, // use [...] and {...} for collections
FlowStyleThreshold = 80, // max line length for flow style
EmitComments = true // emit preserved comments
};
Deserializer settings
var settings = new YamlDeserializerSettings
{
NamingConvention = new SnakeCaseConvention(),
CaseInsensitive = true,
IgnoreUnmatchedProperties = true,
PreserveComments = false, // keep comments for round-trip
ResolveAnchors = true // auto-resolve aliases
};
📚 Examples
1) Lists and nested objects
var yaml = """
first_name: Ada
last_name: Lovelace
age: 36
tags:
- math
- poet
address:
street: 12 St James's Sq
city: London
""";
var des = new YamlDeserializer(new YamlDeserializerSettings { NamingConvention = new SnakeCaseConvention() });
var p = des.Deserialize<Person>(yaml);
var s = new YamlSerializer(new YamlSerializerSettings { NamingConvention = new SnakeCaseConvention(), EmitNulls = false });
var outYaml = s.Serialize(p);
2) Block scalars (| and >)
description: |
First line kept
Second line kept
note: >
Lines are folded
into a single paragraph
These map to string properties on your CLR model.
3) Attributes and explicit names
public sealed class Product
{
[YamlProperty(Name = "product_id")] // explicit YAML key
public Guid Id { get; set; }
[YamlIgnore]
public string? InternalNotes { get; set; }
}
4) Custom converters
public sealed class YesNoBoolConverter : IYamlTypeConverter
{
public bool CanConvert(Type t) => t == typeof(bool);
public object? Read(object? node, Type targetType) => string.Equals(node?.ToString(), "yes", StringComparison.OrdinalIgnoreCase);
public object? Write(object? value, Type declared) => (bool?)value == true ? "yes" : "no";
}
var s = new YamlSerializer(new YamlSerializerSettings());
s.Converters.Add(new YesNoBoolConverter());
var yaml = "tags: [tag1, tag2, tag3]";
var result = YamlDeserializer.Deserialize<MyClass>(yaml);
// Serialize with flow style
var settings = new YamlSerializerSettings { PreferFlowStyle = true };
var output = YamlSerializer.Serialize(obj, settings);
For comprehensive documentation, see the User Guide.
💬 Contributing
We welcome contributions from the community! Whether it's reporting bugs, suggesting features, or submitting pull requests, your involvement helps improve Cortex for everyone.
💬 How to Contribute
Fork the Repository
Create a Feature Branch
git checkout -b feature/YourFeature
Commit Your Changes
git commit -m "Add your feature"
Push to Your Fork
git push origin feature/YourFeature
Open a Pull Request
Describe your changes and submit the pull request for review.
📄 License
This project is licensed under the MIT License.
📚 Sponsorship
Cortex is an open-source project maintained by BuilderSoft. Your support helps us continue developing and improving Cortex. Consider sponsoring us to contribute to the future of resilient streaming platforms.
How to Sponsor
Financial Contributions: Support us through GitHub Sponsors or other preferred platforms.
Corporate Sponsorship: If your organization is interested in sponsoring Cortex, please contact us directly.
