Skip to content

Commit a7502e0

Browse files
artobartob
committed
Create the project.
0 parents  commit a7502e0

18 files changed

+183
-0
lines changed

‎.cargo/config.toml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See: https://doc.rust-lang.org/cargo/reference/config.html
2+
# See: https://docs.shipyard.rs/configuration/git-fetch-with-cli.html
3+
4+
paths = ["lib/protoflow"]
5+
6+
[net]
7+
git-fetch-with-cli = true

‎.gitattributes

Whitespace-only changes.

‎.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @artob

‎.gitignore

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# macOS
2+
.DS_Store
3+
4+
# Environment variables
5+
.env
6+
7+
# Jetbrains
8+
.idea/
9+
10+
# Visual Studio Code
11+
.vscode/
12+
13+
# Editor backup files
14+
*~
15+
16+
# Rust artifacts
17+
/Cargo.lock
18+
/rust-toolchain
19+
/target

‎AUTHORS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* Arto Bendiken <arto@bendiken.net>

‎CHANGES.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## 0.0.0 - 2024-07-14

‎Cargo.toml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# See: https://doc.rust-lang.org/cargo/reference/manifest.html
2+
3+
[workspace]
4+
members = ["lib/*"]
5+
default-members = ["lib/protoflow"]
6+
resolver = "2"
7+
8+
[workspace.package]
9+
version = "0.0.0"
10+
authors = ["Arto Bendiken"]
11+
edition = "2021"
12+
rust-version = "1.70"
13+
description = "Protoflow"
14+
#documentation = "https://github.com/artob/protoflow/blob/master/README.md"
15+
readme = true
16+
homepage = "https://protoflow.rs"
17+
repository = "https://github.com/artob/protoflow"
18+
license = "Unlicense"
19+
keywords = ["protobuf", "flow", "fbp"]
20+
categories = ["concurrency", "network-programming"]
21+
publish = true
22+
23+
[workspace.dependencies]
24+
prost = "0.13"
25+
protoflow = { path = "lib/protoflow" }

‎Makefile

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
CARGO = cargo
2+
3+
all: Cargo.toml
4+
$(CARGO) build
5+
6+
check: Cargo.toml
7+
$(CARGO) test
8+
9+
clean: Cargo.toml
10+
@rm -rf *~ target
11+
$(CARGO) clean
12+
13+
.PHONY: all check clean
14+
.SECONDARY:
15+
.SUFFIXES:

‎README.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Protoflow
2+
3+
[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
4+
[![Compatibility](https://img.shields.io/badge/rust-1.70%2B-blue)](https://rust-lang.org)
5+
[![Package](https://img.shields.io/crates/v/protoflow)](https://crates.io/crates/protoflow)
6+
7+
🚧 _This is presently under heavy construction._
8+
9+
## 🛠️ Prerequisites
10+
11+
- [Rust](https://rust-lang.org) 1.70+
12+
13+
## ⬇️ Installation
14+
15+
### Installation via Cargo
16+
17+
```console
18+
$ cargo add protoflow
19+
```
20+
21+
## 👉 Examples
22+
23+
### Importing the library
24+
25+
```rust
26+
use protoflow::*;
27+
```
28+
29+
## 👨‍💻 Development
30+
31+
```console
32+
$ git clone https://github.com/artob/protoflow.git
33+
```
34+
35+
- - -
36+
37+
[![Share on Twitter](https://img.shields.io/badge/share%20on-twitter-03A9F4?logo=twitter)](https://twitter.com/share?url=https://github.com/artob/protoflow&text=Protoflow)
38+
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit)](https://reddit.com/submit?url=https://github.com/artob/protoflow&title=Protoflow)
39+
[![Share on Hacker News](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator)](https://news.ycombinator.com/submitlink?u=https://github.com/artob/protoflow&t=Protoflow)
40+
[![Share on Facebook](https://img.shields.io/badge/share%20on-facebook-1976D2?logo=facebook)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/artob/protoflow)

‎UNLICENSE

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
This is free and unencumbered software released into the public domain.
2+
3+
Anyone is free to copy, modify, publish, use, compile, sell, or
4+
distribute this software, either in source code form or as a compiled
5+
binary, for any purpose, commercial or non-commercial, and by any
6+
means.
7+
8+
In jurisdictions that recognize copyright laws, the author or authors
9+
of this software dedicate any and all copyright interest in the
10+
software to the public domain. We make this dedication for the benefit
11+
of the public at large and to the detriment of our heirs and
12+
successors. We intend this dedication to be an overt act of
13+
relinquishment in perpetuity of all present and future rights to this
14+
software under copyright law.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19+
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20+
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22+
OTHER DEALINGS IN THE SOFTWARE.
23+
24+
For more information, please refer to <https://unlicense.org/>

‎VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
0.0.0

‎lib/protoflow/Cargo.toml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[package]
2+
name = "protoflow"
3+
version.workspace = true
4+
authors.workspace = true
5+
edition.workspace = true
6+
rust-version.workspace = true
7+
description.workspace = true
8+
#documentation.workspace = true
9+
readme.workspace = true
10+
homepage.workspace = true
11+
repository.workspace = true
12+
license.workspace = true
13+
keywords = ["protobuf", "rpc", "client", "server"]
14+
categories = ["command-line-interface", "network-programming"]
15+
publish.workspace = true
16+
17+
[features]
18+
default = ["std", "tracing"]
19+
std = []
20+
tracing = ["dep:tracing"]
21+
22+
[dependencies]
23+
tracing = { version = "0.1", optional = true }

‎lib/protoflow/src/error.rs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// This is free and unencumbered software released into the public domain.

‎lib/protoflow/src/feature.rs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// This is free and unencumbered software released into the public domain.
2+
3+
#[allow(unused)]
4+
pub static FEATURES: &[&str] = &[];

‎lib/protoflow/src/lib.rs

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// This is free and unencumbered software released into the public domain.
2+
3+
pub mod prelude;
4+
5+
//mod error;
6+
//pub use error::*;
7+
8+
mod feature;
9+
pub use feature::*;

‎lib/protoflow/src/prelude.rs

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// This is free and unencumbered software released into the public domain.

‎lib/protoflow/test/.gitkeep

Whitespace-only changes.

‎rustfmt.toml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# See: https://rust-lang.github.io/rustfmt/
2+
3+
reorder_imports = true
4+
imports_granularity = "Crate"

0 commit comments

Comments
 (0)