Skip to content

[feat] update README.md Rust Definition Package #141

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[feat] update README.md Rust Definition Package #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,10 @@ for (const feature in features) {
```

## Rust Definition Package
This package is a Rust crate designed to read and parse Code0 definition files (JSON) from a directory structure. It loads all features, including their data types, flow types, and runtime functions, providing them as idiomatic Rust structs.

### Package Resources
Create: [code0-definition-reader](https://crates.io/crates/code0-definition-reader) on crates.io
### Install Package
```bash
cargo add code0-definition-reader
Expand All @@ -99,14 +102,23 @@ cargo add code0-definition-reader
### Usage

```rs
use code0_definition_reader::Definition;
use code0_definition_reader::Reader;

let features = Definition::new("./path/to/definitions");
let reader = Reader::configure(
String::new(), // Path required for configure
false, // should_break
Vec::new(), // accepted_features
None // accepted_versions
);

let features = reader.read_features("./path/to/definitions");

for feature in features {
let name = feature.name(); //name of the feature (e.g. rest)
let data_types = feature.data_types(); //dataTypes of this feature
let flow_types = feature.flow_types(); //flowTypes of this feature
let functions = feature.runtime_functions(); //runtimeFunctions of this feature
let name = &feature.name; // name of the feature (e.g., http)
let data_types = &feature.data_types; // dataTypes of this feature
let flow_types = &feature.flow_types; // flowTypes of this feature
let functions = &feature.functions; // runtimeFunctions of this feature

println!("Loaded feature: {}", name);
}
```