Update licence, readme, doc.
This commit is contained in:
parent
f2d0968a89
commit
2481df7f9d
19 changed files with 311 additions and 120 deletions
|
@ -1,3 +1,18 @@
|
||||||
|
Copyright (c) 2015 Chen Yuheng
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
|
||||||
Apache License
|
Apache License
|
||||||
Version 2.0, January 2004
|
Version 2.0, January 2004
|
||||||
http://www.apache.org/licenses/
|
http://www.apache.org/licenses/
|
||||||
|
@ -174,28 +189,3 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
of your accepting any such warranty or additional liability.
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
you may not use this file except in compliance with the License.
|
|
||||||
You may obtain a copy of the License at
|
|
||||||
|
|
||||||
http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
|
|
||||||
Unless required by applicable law or agreed to in writing, software
|
|
||||||
distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
See the License for the specific language governing permissions and
|
|
||||||
limitations under the License.
|
|
191
parser/.licenses/Ethiraric-Apache
Normal file
191
parser/.licenses/Ethiraric-Apache
Normal file
|
@ -0,0 +1,191 @@
|
||||||
|
Copyright (c) 2023 Ethiraric
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
|
|
||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
21
parser/.licenses/Ethiraric-MIT
Normal file
21
parser/.licenses/Ethiraric-MIT
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2023 Ethiraric
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -1,12 +1,14 @@
|
||||||
[package]
|
[package]
|
||||||
name = "yaml-rust"
|
name = "yaml-rust2"
|
||||||
version = "0.4.5" # remember to update html_root_url
|
version = "0.5.0"
|
||||||
authors = ["Yuheng Chen <yuhengchen@sensetime.com>"]
|
authors = [
|
||||||
homepage = "http://chyh1990.github.io/yaml-rust/"
|
"Yuheng Chen <yuhengchen@sensetime.com>",
|
||||||
documentation = "https://docs.rs/yaml-rust"
|
"Ethiraric <ethiraric@gmail.com>"
|
||||||
|
]
|
||||||
|
documentation = "https://docs.rs/yaml-rust2"
|
||||||
license = "MIT/Apache-2.0"
|
license = "MIT/Apache-2.0"
|
||||||
description = "The missing YAML 1.2 parser for rust"
|
description = "A fully YAML 1.2 compliant YAML parser"
|
||||||
repository = "https://github.com/chyh1990/yaml-rust"
|
repository = "https://github.com/Ethiraric/yaml-rust2"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
|
||||||
|
|
9
parser/LICENSE
Normal file
9
parser/LICENSE
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
Code up to and including commit `da52a68615f2ecdd6b7e4567019f280c433c1521` is licensed by Chen Yuheng under either of:
|
||||||
|
- [Apache License, Version 2.0](.licenses/ChenYuheng-Apache) (http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
- [MIT License](./licenses/ChenYuheng-MIT) (http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
Code modifications starting with commit `1d71a23b151dcc12b289d0f06d8207dd9c764216` (included) are licenced by Ethiraric under either of:
|
||||||
|
- [Apache License, Version 2.0](.licenses/Ethiraric-Apache) (http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
|
- [MIT License](./licenses/Ethiraric-MIT) (http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
|
Redistributions of this Work must include licenses of both Chen Yuheng and Ethiraric.
|
|
@ -1,16 +1,13 @@
|
||||||
# yaml-rust
|
# yaml-rust2
|
||||||
|
|
||||||
The missing YAML 1.2 implementation for Rust.
|
A fully compliant YAML 1.2 implementation written in pure Rust.
|
||||||
|
This work is based on [`yaml-rust`](https://github.com/chyh1990/yaml-rust) with
|
||||||
|
fixes towards being compliant to the [YAML test
|
||||||
|
suite](https://github.com/yaml/yaml-test-suite/). `yaml-rust`'s parser is
|
||||||
|
heavily influenced by `libyaml` and `yaml-cpp`.
|
||||||
|
|
||||||
[![Travis](https://travis-ci.org/chyh1990/yaml-rust.svg?branch=master)](https://travis-ci.org/chyh1990/yaml-rust)
|
`yaml-rust2` is a pure Rust YAML 1.2 implementation, which enjoys the memory
|
||||||
[![AppVeyor](https://ci.appveyor.com/api/projects/status/scf47535ckp4ylg4?svg=true)](https://ci.appveyor.com/project/chyh1990/yaml-rust)
|
safety property and other benefits from the Rust language.
|
||||||
[![crates.io](https://img.shields.io/crates/v/yaml-rust.svg)](https://crates.io/crates/yaml-rust)
|
|
||||||
[![docs.rs](https://img.shields.io/badge/api-rustdoc-blue.svg)](https://docs.rs/yaml-rust)
|
|
||||||
|
|
||||||
`yaml-rust` is a pure Rust YAML 1.2 implementation,
|
|
||||||
which enjoys the memory safety
|
|
||||||
property and other benefits from the Rust language.
|
|
||||||
The parser is heavily influenced by `libyaml` and `yaml-cpp`.
|
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
|
@ -18,21 +15,13 @@ Add the following to the Cargo.toml of your project:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
[dependencies]
|
[dependencies]
|
||||||
yaml-rust = "0.4"
|
yaml-rust2 = "0.5"
|
||||||
```
|
```
|
||||||
|
|
||||||
and import:
|
Use `yaml_rust2::YamlLoader` to load YAML documents and access them as `Yaml` objects:
|
||||||
|
|
||||||
```rust
|
```rust
|
||||||
extern crate yaml_rust;
|
use yaml_rust2::{YamlLoader, YamlEmitter};
|
||||||
```
|
|
||||||
|
|
||||||
Use `yaml::YamlLoader` to load the YAML documents and access it
|
|
||||||
as Vec/HashMap:
|
|
||||||
|
|
||||||
```rust
|
|
||||||
extern crate yaml_rust;
|
|
||||||
use yaml_rust::{YamlLoader, YamlEmitter};
|
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
let s =
|
let s =
|
||||||
|
@ -56,8 +45,8 @@ bar:
|
||||||
assert_eq!(doc["foo"][0].as_str().unwrap(), "list1");
|
assert_eq!(doc["foo"][0].as_str().unwrap(), "list1");
|
||||||
assert_eq!(doc["bar"][1].as_f64().unwrap(), 2.0);
|
assert_eq!(doc["bar"][1].as_f64().unwrap(), 2.0);
|
||||||
|
|
||||||
// Chained key/array access is checked and won't panic,
|
// Array/map-like accesses are checked and won't panic.
|
||||||
// return BadValue if they are not exist.
|
// They will return `BadValue` if the access is invalid.
|
||||||
assert!(doc["INVALID_KEY"][100].is_badvalue());
|
assert!(doc["INVALID_KEY"][100].is_badvalue());
|
||||||
|
|
||||||
// Dump the YAML object
|
// Dump the YAML object
|
||||||
|
@ -70,56 +59,48 @@ bar:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that `yaml_rust::Yaml` implements `Index<&'a str>` & `Index<usize>`:
|
Note that `yaml_rust2::Yaml` implements `Index<&'a str>` and `Index<usize>`:
|
||||||
|
|
||||||
* `Index<usize>` assumes the container is an Array
|
* `Index<usize>` assumes the container is an array
|
||||||
* `Index<&'a str>` assumes the container is a string to value Map
|
* `Index<&'a str>` assumes the container is a string to value map
|
||||||
* otherwise, `Yaml::BadValue` is returned
|
* otherwise, `Yaml::BadValue` is returned
|
||||||
|
|
||||||
If your document does not conform to this convention (e.g. map with
|
If your document does not conform to this convention (e.g. map with complex
|
||||||
complex type key), you can use the `Yaml::as_XXX` family API to access your
|
type key), you can use the `Yaml::as_XXX` family API of functions to access
|
||||||
documents.
|
your objects.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Pure Rust
|
* Pure Rust
|
||||||
* Ruby-like Array/Hash access API
|
* `Vec`/`HashMap` access API
|
||||||
* Low-level YAML events emission
|
* Low-level YAML events emission
|
||||||
|
|
||||||
## Specification Compliance
|
## Specification Compliance
|
||||||
|
|
||||||
This implementation aims to provide YAML parser fully compatible with
|
This implementation is fully compatible with the YAML 1.2 specification. In
|
||||||
the YAML 1.2 specification. The parser can correctly parse almost all
|
order to help with compliance, `yaml-rust2` tests against (and passes) the [YAML
|
||||||
examples in the specification, except for the following known bugs:
|
test suite](https://github.com/yaml/yaml-test-suite/).
|
||||||
|
|
||||||
* Empty plain scalar in certain contexts
|
|
||||||
|
|
||||||
However, the widely used library `libyaml` also fails to parse these examples,
|
|
||||||
so it may not be a huge problem for most users.
|
|
||||||
|
|
||||||
## Goals
|
|
||||||
|
|
||||||
* Encoder
|
|
||||||
* Tag directive
|
|
||||||
* Alias while deserialization
|
|
||||||
|
|
||||||
## Minimum Rust version policy
|
|
||||||
|
|
||||||
This crate's minimum supported `rustc` version is 1.31 (released with Rust 2018, after v0.4.3), as this is the currently known minimum version for [`regex`](https://crates.io/crates/regex#minimum-rust-version-policy) as well.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Licensed under either of
|
Licensed under either of
|
||||||
|
|
||||||
* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
|
* Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
|
||||||
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
|
* MIT license (http://opensource.org/licenses/MIT)
|
||||||
|
|
||||||
at your option.
|
at your option.
|
||||||
|
|
||||||
|
Since this repository was originally maintained by
|
||||||
|
[chyh1990](https://github.com/chyh1990), there are 2 sets of licenses.
|
||||||
|
A license of each set must be included in redistributions. See the
|
||||||
|
[LICENSE](LICENSE) file for more details.
|
||||||
|
|
||||||
|
You can find licences in the [`.licenses`](.licenses) subfolder.
|
||||||
|
|
||||||
## Contribution
|
## Contribution
|
||||||
|
|
||||||
Fork & PR on Github.
|
Fork & PR on Github.
|
||||||
|
|
||||||
Unless you explicitly state otherwise, any contribution intentionally submitted
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
||||||
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
|
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
|
||||||
additional terms or conditions.
|
be dual licensed as above, without any additional terms or conditions.
|
||||||
|
|
|
@ -1,9 +1,7 @@
|
||||||
extern crate yaml_rust;
|
|
||||||
|
|
||||||
use std::env;
|
use std::env;
|
||||||
use std::fs::File;
|
use std::fs::File;
|
||||||
use std::io::prelude::*;
|
use std::io::prelude::*;
|
||||||
use yaml_rust::{
|
use yaml_rust2::{
|
||||||
parser::{MarkedEventReceiver, Parser},
|
parser::{MarkedEventReceiver, Parser},
|
||||||
scanner::Marker,
|
scanner::Marker,
|
||||||
Event,
|
Event,
|
||||||
|
|
|
@ -1,9 +1,7 @@
|
||||||
extern crate yaml_rust;
|
|
||||||
|
|
||||||
use std::env;
|
use std::env;
|
||||||
use std::fs::File;
|
use std::fs::File;
|
||||||
use std::io::prelude::*;
|
use std::io::prelude::*;
|
||||||
use yaml_rust::yaml;
|
use yaml_rust2::yaml;
|
||||||
|
|
||||||
fn print_indent(indent: usize) {
|
fn print_indent(indent: usize) {
|
||||||
for _ in 0..indent {
|
for _ in 0..indent {
|
||||||
|
|
|
@ -1,23 +1,24 @@
|
||||||
// Copyright 2015, Yuheng Chen. See the LICENSE file at the top-level
|
// Copyright 2015, Yuheng Chen.
|
||||||
// directory of this distribution.
|
// Copyright 2023, Ethiraric.
|
||||||
|
// See the LICENSE file at the top-level directory of this distribution.
|
||||||
|
|
||||||
//! YAML 1.2 implementation in pure Rust.
|
//! YAML 1.2 implementation in pure Rust.
|
||||||
//!
|
//!
|
||||||
//! # Usage
|
//! # Usage
|
||||||
//!
|
//!
|
||||||
//! This crate is [on github](https://github.com/chyh1990/yaml-rust) and can be
|
//! This crate is [on github](https://github.com/Ethiraric/yaml-rust2) and can be used by adding
|
||||||
//! used by adding `yaml-rust` to the dependencies in your project's `Cargo.toml`.
|
//! `yaml-rust2` to the dependencies in your project's `Cargo.toml`.
|
||||||
//!
|
//!
|
||||||
//! ```toml
|
//! ```toml
|
||||||
//! [dependencies]
|
//! [dependencies]
|
||||||
//! yaml-rust = "0.4"
|
//! yaml-rust2 = "0.5.0"
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
//! # Examples
|
//! # Examples
|
||||||
//! Parse a string into `Vec<Yaml>` and then serialize it as a YAML string.
|
//! Parse a string into `Vec<Yaml>` and then serialize it as a YAML string.
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! use yaml_rust::{YamlLoader, YamlEmitter};
|
//! use yaml_rust2::{YamlLoader, YamlEmitter};
|
||||||
//!
|
//!
|
||||||
//! let docs = YamlLoader::load_from_str("[1, 2, 3]").unwrap();
|
//! let docs = YamlLoader::load_from_str("[1, 2, 3]").unwrap();
|
||||||
//! let doc = &docs[0]; // select the first YAML document
|
//! let doc = &docs[0]; // select the first YAML document
|
||||||
|
@ -29,7 +30,7 @@
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
#![doc(html_root_url = "https://docs.rs/yaml-rust/0.4.5")]
|
#![doc(html_root_url = "https://docs.rs/yaml-rust2/0.5.0")]
|
||||||
#![cfg_attr(feature = "cargo-clippy", warn(clippy::pedantic))]
|
#![cfg_attr(feature = "cargo-clippy", warn(clippy::pedantic))]
|
||||||
#![cfg_attr(
|
#![cfg_attr(
|
||||||
feature = "cargo-clippy",
|
feature = "cargo-clippy",
|
||||||
|
|
|
@ -153,7 +153,7 @@ pub struct Parser<T> {
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Example
|
||||||
/// ```
|
/// ```
|
||||||
/// # use yaml_rust::parser::{Event, EventReceiver, Parser};
|
/// # use yaml_rust2::parser::{Event, EventReceiver, Parser};
|
||||||
/// #
|
/// #
|
||||||
/// /// Sink of events. Collects them into an array.
|
/// /// Sink of events. Collects them into an array.
|
||||||
/// struct EventSink {
|
/// struct EventSink {
|
||||||
|
@ -508,7 +508,7 @@ impl<T: Iterator<Item = char>> Parser<T> {
|
||||||
// return Err(ScanError::new(tok.0,
|
// return Err(ScanError::new(tok.0,
|
||||||
// "found incompatible YAML document"));
|
// "found incompatible YAML document"));
|
||||||
//}
|
//}
|
||||||
if version_directive_received == true {
|
if version_directive_received {
|
||||||
return Err(ScanError::new(*mark, "duplicate version directive"));
|
return Err(ScanError::new(*mark, "duplicate version directive"));
|
||||||
}
|
}
|
||||||
version_directive_received = true;
|
version_directive_received = true;
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
#![allow(clippy::module_name_repetitions)]
|
#![allow(clippy::module_name_repetitions)]
|
||||||
|
|
||||||
|
use std::{collections::BTreeMap, convert::TryFrom, mem, ops::Index};
|
||||||
|
|
||||||
|
use linked_hash_map::LinkedHashMap;
|
||||||
|
|
||||||
use crate::parser::{Event, MarkedEventReceiver, Parser, Tag};
|
use crate::parser::{Event, MarkedEventReceiver, Parser, Tag};
|
||||||
use crate::scanner::{Marker, ScanError, TScalarStyle};
|
use crate::scanner::{Marker, ScanError, TScalarStyle};
|
||||||
use linked_hash_map::LinkedHashMap;
|
|
||||||
use std::collections::BTreeMap;
|
|
||||||
use std::mem;
|
|
||||||
use std::ops::Index;
|
|
||||||
|
|
||||||
/// A YAML node is stored as this `Yaml` enumeration, which provides an easy way to
|
/// A YAML node is stored as this `Yaml` enumeration, which provides an easy way to
|
||||||
/// access your YAML document.
|
/// access your YAML document.
|
||||||
|
@ -13,7 +13,7 @@ use std::ops::Index;
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use yaml_rust::Yaml;
|
/// use yaml_rust2::Yaml;
|
||||||
/// let foo = Yaml::from_str("-123"); // convert the string to the appropriate YAML type
|
/// let foo = Yaml::from_str("-123"); // convert the string to the appropriate YAML type
|
||||||
/// assert_eq!(foo.as_i64().unwrap(), -123);
|
/// assert_eq!(foo.as_i64().unwrap(), -123);
|
||||||
///
|
///
|
||||||
|
@ -317,7 +317,7 @@ impl Yaml {
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
/// ```
|
/// ```
|
||||||
/// # use yaml_rust::yaml::Yaml;
|
/// # use yaml_rust2::yaml::Yaml;
|
||||||
/// assert!(matches!(Yaml::from_str("42"), Yaml::Integer(42)));
|
/// assert!(matches!(Yaml::from_str("42"), Yaml::Integer(42)));
|
||||||
/// assert!(matches!(Yaml::from_str("0x2A"), Yaml::Integer(42)));
|
/// assert!(matches!(Yaml::from_str("0x2A"), Yaml::Integer(42)));
|
||||||
/// assert!(matches!(Yaml::from_str("0o52"), Yaml::Integer(42)));
|
/// assert!(matches!(Yaml::from_str("0o52"), Yaml::Integer(42)));
|
||||||
|
@ -379,7 +379,7 @@ impl Index<usize> for Yaml {
|
||||||
if let Some(v) = self.as_vec() {
|
if let Some(v) = self.as_vec() {
|
||||||
v.get(idx).unwrap_or(&BAD_VALUE)
|
v.get(idx).unwrap_or(&BAD_VALUE)
|
||||||
} else if let Some(v) = self.as_hash() {
|
} else if let Some(v) = self.as_hash() {
|
||||||
let key = Yaml::Integer(idx as i64);
|
let key = Yaml::Integer(i64::try_from(idx).unwrap());
|
||||||
v.get(&key).unwrap_or(&BAD_VALUE)
|
v.get(&key).unwrap_or(&BAD_VALUE)
|
||||||
} else {
|
} else {
|
||||||
&BAD_VALUE
|
&BAD_VALUE
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
#![allow(clippy::float_cmp)]
|
#![allow(clippy::float_cmp)]
|
||||||
|
|
||||||
use std::vec;
|
use std::vec;
|
||||||
use yaml_rust::{Yaml, YamlEmitter, YamlLoader};
|
use yaml_rust2::{Yaml, YamlEmitter, YamlLoader};
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_api() {
|
fn test_api() {
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
use yaml_rust::{YamlEmitter, YamlLoader};
|
use yaml_rust2::{YamlEmitter, YamlLoader};
|
||||||
|
|
||||||
#[allow(clippy::similar_names)]
|
#[allow(clippy::similar_names)]
|
||||||
#[test]
|
#[test]
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
extern crate yaml_rust;
|
extern crate yaml_rust2;
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
extern crate quickcheck;
|
extern crate quickcheck;
|
||||||
|
|
||||||
use quickcheck::TestResult;
|
use quickcheck::TestResult;
|
||||||
use yaml_rust::{Yaml, YamlEmitter, YamlLoader};
|
use yaml_rust2::{Yaml, YamlEmitter, YamlLoader};
|
||||||
|
|
||||||
quickcheck! {
|
quickcheck! {
|
||||||
fn test_check_weird_keys(xs: Vec<String>) -> TestResult {
|
fn test_check_weird_keys(xs: Vec<String>) -> TestResult {
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
#![allow(clippy::enum_glob_use)]
|
#![allow(clippy::enum_glob_use)]
|
||||||
|
|
||||||
use yaml_rust::{scanner::TokenType::*, scanner::*};
|
use yaml_rust2::{scanner::TokenType::*, scanner::*};
|
||||||
|
|
||||||
macro_rules! next {
|
macro_rules! next {
|
||||||
($p:ident, $tk:pat) => {{
|
($p:ident, $tk:pat) => {{
|
||||||
|
|
|
@ -1,9 +1,9 @@
|
||||||
#![allow(dead_code)]
|
#![allow(dead_code)]
|
||||||
#![allow(non_upper_case_globals)]
|
#![allow(non_upper_case_globals)]
|
||||||
extern crate yaml_rust;
|
extern crate yaml_rust2;
|
||||||
|
|
||||||
use yaml_rust::parser::{Event, EventReceiver, Parser};
|
use yaml_rust2::parser::{Event, EventReceiver, Parser};
|
||||||
use yaml_rust::scanner::TScalarStyle;
|
use yaml_rust2::scanner::TScalarStyle;
|
||||||
|
|
||||||
// These names match the names used in the C++ test suite.
|
// These names match the names used in the C++ test suite.
|
||||||
#[cfg_attr(feature = "cargo-clippy", allow(clippy::enum_variant_names))]
|
#[cfg_attr(feature = "cargo-clippy", allow(clippy::enum_variant_names))]
|
||||||
|
@ -76,8 +76,8 @@ include!("spec_test.rs.inc");
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_mapvec_legal() {
|
fn test_mapvec_legal() {
|
||||||
use yaml_rust::yaml::{Hash, Yaml};
|
use yaml_rust2::yaml::{Hash, Yaml};
|
||||||
use yaml_rust::{YamlEmitter, YamlLoader};
|
use yaml_rust2::{YamlEmitter, YamlLoader};
|
||||||
|
|
||||||
// Emitting a `map<map<seq<_>>, _>` should result in legal yaml that
|
// Emitting a `map<map<seq<_>>, _>` should result in legal yaml that
|
||||||
// we can parse.
|
// we can parse.
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
extern crate yaml_rust;
|
extern crate yaml_rust2;
|
||||||
|
|
||||||
use yaml_rust::{Yaml, YamlEmitter, YamlLoader};
|
use yaml_rust2::{Yaml, YamlEmitter, YamlLoader};
|
||||||
|
|
||||||
fn roundtrip(original: &Yaml) {
|
fn roundtrip(original: &Yaml) {
|
||||||
let mut emitted = String::new();
|
let mut emitted = String::new();
|
||||||
|
|
|
@ -2,7 +2,7 @@ use std::fs::{self, DirEntry};
|
||||||
|
|
||||||
use libtest_mimic::{run_tests, Arguments, Outcome, Test};
|
use libtest_mimic::{run_tests, Arguments, Outcome, Test};
|
||||||
|
|
||||||
use yaml_rust::{
|
use yaml_rust2::{
|
||||||
parser::{Event, EventReceiver, Parser, Tag},
|
parser::{Event, EventReceiver, Parser, Tag},
|
||||||
scanner::TScalarStyle,
|
scanner::TScalarStyle,
|
||||||
yaml, ScanError, Yaml, YamlLoader,
|
yaml, ScanError, Yaml, YamlLoader,
|
||||||
|
|
Loading…
Reference in a new issue