# Try\<Encoding\>From  (try_encoding_from)

## Branch Status

| dev                                   | test                                 | main                      |
| :-----------------------------------: | :----------------------------------: | :-----------------------: |
| [![CodeBuild(dev)]][CodeBuild(dev)]   |[![CodeBuild(test)]][CodeBuild(test)] | [![CodeBuild]][CodeBuild] |

[![Version badge]][crates.io]
[![Docs badge]][docs.rs]

[CodeBuild]: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiV1VGcDVGZUZYTnM4bldvK2xQOVZxL1JFWm10Y3I3MmNNRmtGSjJHa1Z6aFE3djh4VVdXRlNoa2ROYUdMOU5WZzl6Q0RhaUhDSDR5VkhGTnNsMkdGNG9ZPSIsIml2UGFyYW1ldGVyU3BlYyI6IlRaVlI1ZHVUVVVwUjFNZ1kiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=main
[CodeBuild(test)]: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiTnhqdFFTcDZRTlBzTWdWNDBCL1dQWms4R1RINHlDNWRSOUtOQjJXVGlzYlBaWGdGdlJTcGZVNkE0RHQ5aXNXTzlLdC9oTHZuak9rb3pmL1IzSzA0Zi9nPSIsIml2UGFyYW1ldGVyU3BlYyI6IllEMWJpOURueWNta0lScnoiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=test
[CodeBuild(dev)]: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiVEFxdFdWcHh3R01XTUxhd1ErL2tTRUlDM0E3VktGRnlRblJ3Y3dyUzVnRkU3OUVmZkxxcldtU3dyU3hjcnlpM1FBdlUrVDZFeWdKd2ZGYTJMK0JJanJJPSIsIml2UGFyYW1ldGVyU3BlYyI6IkhVMHFnUWVXU1NzOEJySi8iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=dev
[Version badge]: https://img.shields.io/crates/v/try_encoding_from
[crates.io]: https://crates.io/crates/try_encoding_from
[Docs badge]: https://img.shields.io/badge/docs.rs-rustdoc-blue
[docs.rs]: https://docs.rs/try_encoding_from/

This library contains a convenient API wrapper for `serde_json`,
`serde_yaml`, and `serde_cbor` inspired by the `TryFrom` and
`TryInto` traits.

The `serde`, `serde_json`, `serde_yaml`, and `serde_cbor` crates
are included and available under the feature flags:
`json`, `yaml`, and `cbor`.
Please see the encoding module's [API](./src/encoding/api.rs)
for the available optional trait definitions. *Note: using
`json`, `yaml`, or `cbor` features will
require inclusion of the `serde` crate as Serialize, Deserialize,
DeserializeOwned traits are required for the library to compile.*

## Example
```rust
use try_encoding_from::TryJsonFrom;
use btree_graph::{BTreeGraph, AddVertex, AddEdge, Vertices};

fn main() {
    // Add three nodes.
    let mut graph: BTreeGraph<usize, usize> = BTreeGraph::new();
    graph.add_vertex(0);
    graph.add_vertex(1);
    graph.add_vertex(2);

    // Check there is indeed three nodes.
    assert_eq!(graph.vertices().len(), 3);

    // Add an edge (0, 1) = 2, (1, 2) = 3, and (0, 2) = 4.
    graph.add_edge(0, 1, 2).unwrap();
    graph.add_edge(1, 2, 3).unwrap();
    graph.add_edge(0, 2, 4).unwrap();

    let json_string: String = String::try_json_from(graph)?;
    assert_eq!(json_string, String::from("{\"vertices\":{\"0\":[2,4],\"1\":[3],\"2\":[]},\"edges\":{\"2\":[0,1],\"3\":[1,2],\"4\":[0,2]}}"));
}
```

## Usage

Add the following to your `Cargo.toml` file:
```toml
[dependencies]
try_encoding_from = "0.1.3"
```

## API

Please see the [API](src/encoding/api.rs) for a full list of
available methods.

## License

This work is dually licensed under MIT OR Apache-2.0.