ByteFlow 1.0.0

ByteFlow

ByteFlow is a fluent, chainable .NET library for sequential byte array transformations. It provides an elegant, type-safe API for applying compression, encryption, hashing, and custom processing operations to binary data in a pipeline fashion.

Quick Start

using ByteFlow;

// Create a chain from a file, compress, encrypt, and compute hash
byte[] result = ByteFlow
    .FromFile("data.bin")
    .CompressWith<GZipCompressor>()
    .EncryptWith<AesGcmEncryptor>(encryptionKey)
    .HashWith<SHA256Hasher>()
    .Build();

// Or from a string
byte[] processed = ByteFlow
    .FromString("Hello, World!")
    .EncodeToBase64()
    .Build();

Core

ByteFlow Static Class

Factory methods for creating ByteFlowChain instances from various sources:

• From(byte[]) - Raw byte array
• FromFile(string) / FromFileAsync(string) - File contents
• FromStream(Stream) - Stream data
• FromString(string, Encoding?) - Text with optional encoding

ByteFlowChain Class

Represents a chain of transformations that can be applied sequentially. Each transformation returns the same instance for fluent chaining.

Available Transformations

Compression/Decompression

Supports multiple algorithms via the ICompressor interface:

• BrotliCompressor - Brotli compression
• DeflateCompressor - DEFLATE compression
• GZipCompressor - GZip compression
• ZLibCompressor - ZLib compression

.CompressWith<GZipCompressor>(CompressionLevel.Optimal)
.DecompressWith<GZipCompressor>()

Encryption/Decryption

Authenticated encryption via the IEncryptor interface:

• AesCcmEncryptor - AES-CCM mode
• AesGcmEncryptor - AES-GCM mode
• ChaCha20Poly1305Encryptor - ChaCha20-Poly1305

.EncryptWith<AesGcmEncryptor>(key, associatedData)
.DecryptWith<AesGcmEncryptor>(key, associatedData)

Hashing

Cryptographic hashing via the IHasher interface:

• SHA256Hasher, SHA384Hasher, SHA512Hasher
• SHA3_256Hasher, SHA3_384Hasher, SHA3_512Hasher
• Blake2bHasher, Blake2sHasher, Blake3Hasher

.HashWith<SHA256Hasher>()

Encoding

• EncodeToBase64() - Convert bytes to Base64 string (as UTF-8 bytes)
• DecodeFromBase64() - Decode Base64 string back to bytes

Validation & Custom Processing

• Validate(Func<byte[], bool>) - Validate data during processing
• AddProcessor(Func<byte[], byte[]>) - Add custom transformation