https://github.com/sunfishcode/basic-text

Basic Text strings and I/O streams
https://github.com/sunfishcode/basic-text

plain text

Last synced: 5 days ago
JSON representation

Basic Text strings and I/O streams

• Host: GitHub
• URL: https://github.com/sunfishcode/basic-text
• Owner: sunfishcode
• License: other
• Created: 2020-12-03T02:35:44.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T20:39:12.000Z (8 months ago)
• Last Synced: 2024-05-09T14:39:51.996Z (6 months ago)
• Topics: plain, text
• Language: Rust
• Homepage: https://basic-text.sunfishcode.online
• Size: 524 KB
• Stars: 7
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  
basic-text


  


    Basic Text strings and I/O streams

  


  


    

    

    

  



This repository hosts a project to define a text format called [Basic Text], a

subset of Unicode that focuses on *text*: it excludes unprintable control

characters, characters which depend on out-of-band information to interpret,

non-characters, deprecated characters, and more, while aiming to preserve

everything of practical use to plain text and formats built on top of it. See

the [Book] for more information.

It also includes a Rust crate which aims to implement the Basic Text format,

providing several utilities:

 - [`TextString`] and [`TextStr`] are similar to the standard library's

   [`String`] and [`str`], but use the Basic Text string format, along with a

   [`text!("...")` macro] for Basic Text string literals.

 - [`TextReader`] and [`TextWriter`] are input and output streams which use the

   Basic Text stream format. On input, content is converted in a way which is

   lossy with respect to the original bytestream. Output uses the "strict"

   conversion method, in which invalid content is diagnosed with errors.

 - [`BufReadText`], an extension trait that adds [`text_lines`] and

   [`text_lines_lossy`] to [`BufRead`] implementations for reading lines

   from an input stream as `BasicText` strings.

 - [`TextDuplexer`] is a [`Duplex`] for reading and writing on an interactive

   stream using Basic Text.

The code here is usable, and implements everything in the [Basic Text] spec,

but is not very mature or optimized yet.

[`TextString`]: https://docs.rs/basic-text/latest/basic_text/struct.TextString.html

[`TextStr`]: https://docs.rs/basic-text/latest/basic_text/struct.TextStr.html

[`TextReader`]: https://docs.rs/basic-text/latest/basic_text/struct.TextReader.html

[`TextWriter`]: https://docs.rs/basic-text/latest/basic_text/struct.TextWriter.html

[`TextDuplexer`]: https://docs.rs/basic-text/latest/basic_text/struct.TextDuplexer.html

[`BufReadText`]: https://docs.rs/basic-text/latest/basic_text/trait.BufReadText.html

[`text!("...")` macro]: https://docs.rs/basic-text/latest/basic_text/macro.text.html

[`text_lines`]: https://docs.rs/basic-text/latest/basic_text/trait.BufReadText.html#method.text_lines

[`text_lines_lossy`]: https://docs.rs/basic-text/latest/basic_text/trait.BufReadText.html#method.text_lines_lossy

[`str`]: https://doc.rust-lang.org/std/primitive.str.html

[`String`]: https://doc.rust-lang.org/std/string/struct.String.html

[`BufRead`]: https://doc.rust-lang.org/std/io/trait.BufRead.html

[`Duplex`]: https://docs.rs/duplex/latest/duplex/trait.Duplex.html

[Basic Text]: docs/BasicText.md

[Book]: https://basic-text.sunfishcode.online