diff options
Diffstat (limited to 'vendor/dissimilar/README.md')
-rw-r--r-- | vendor/dissimilar/README.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/vendor/dissimilar/README.md b/vendor/dissimilar/README.md new file mode 100644 index 000000000..492bced22 --- /dev/null +++ b/vendor/dissimilar/README.md @@ -0,0 +1,64 @@ +Dissimilar: diff library with semantic cleanup +============================================== + +[<img alt="github" src="https://img.shields.io/badge/github-dtolnay/dissimilar-8da0cb?style=for-the-badge&labelColor=555555&logo=github" height="20">](https://github.com/dtolnay/dissimilar) +[<img alt="crates.io" src="https://img.shields.io/crates/v/dissimilar.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/dissimilar) +[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-dissimilar-66c2a5?style=for-the-badge&labelColor=555555&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/dissimilar) +[<img alt="build status" src="https://img.shields.io/github/workflow/status/dtolnay/dissimilar/CI/master?style=for-the-badge" height="20">](https://github.com/dtolnay/dissimilar/actions?query=branch%3Amaster) + +This library is a port of the Diff component of [Diff Match Patch] to Rust. The +diff implementation is based on [Myers' diff algorithm] but includes some +[semantic cleanups] to increase human readability by factoring out commonalities +which are likely to be coincidental. + +Diff Match Patch was originally built in 2006 to power Google Docs. + +[Diff Match Patch]: https://github.com/google/diff-match-patch +[Myers' diff algorithm]: https://neil.fraser.name/writing/diff/myers.pdf +[semantic cleanups]: https://neil.fraser.name/writing/diff/ + +```toml +[dependencies] +dissimilar = "1.0" +``` + +*Compiler support: requires rustc 1.31+* + +<br> + +## Interface + +Here is the entire API of the Rust implementation. It operates on borrowed +strings and the return value of the diff algorithm is a vector of chunks +pointing into slices of those input strings. + +```rust +pub enum Chunk<'a> { + Equal(&'a str), + Delete(&'a str), + Insert(&'a str), +} + +pub fn diff(text1: &str, text2: &str) -> Vec<Chunk>; +``` + +<br> + +## License + +The diff algorithm in this crate was ported to Rust using the Java and C++ +implementations found at <https://github.com/google/diff-match-patch> as +reference, and is made available here under the <a href="LICENSE-APACHE">Apache +License, Version 2.0</a> matching the license of the original. This entire +project, including some parts unmodified from upstream and the Rust-specific +modifications introduced in the course of porting the implementation, are +distributed under this Apache license. + +Intellectual property that is unique to the Rust implementation is additionally +made available to you dually under the <a href="LICENSE-MIT">MIT license</a>, if +you prefer. This applies to all design choices and implementation choices not +found in the upstream repo. + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate by you, as defined in the Apache-2.0 license, shall +be dual Apache and MIT licensed, without any additional terms or conditions. |