1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-25 17:40:30 +00:00
CC-Tweaked/doc
Jonathan Coates 0c0556a5bc
Always use raw bytes in file handles
Historically CC has supported two modes when working with file handles
(and HTTP requests):

 - Text mode, which reads/write using UTF-8.
 - Binary mode, which reads/writes the raw bytes.

However, this can be confusing at times. CC/Lua doesn't actually support
unicode, so any characters beyond the 0.255 range were replaced with
'?'. This meant that most of the time you were better off just using
binary mode.

This commit unifies text and binary mode - we now /always/ read the raw
bytes of the file, rather than converting to/from UTF-8. Binary mode now
only specifies whether handle.read() returns a number (and .write(123)
writes a byte rather than coercing to a string).

 - Refactor the entire handle hierarchy. We now have an AbstractMount
   base class, which has the concrete implementation of all methods. The
   public-facing classes then re-export these methods by annotating
   them with @LuaFunction.

   These implementations are based on the
   Binary{Readable,Writable}Handle classes. The Encoded{..}Handle
   versions are now entirely removed.

 - As we no longer need to use BufferedReader/BufferedWriter, we can
   remove quite a lot of logic in Filesystem to handle wrapping
   closeable objects.

 - Add a new WritableMount.openFile method, which generalises
   openForWrite/openForAppend to accept OpenOptions. This allows us to
   support update mode (r+, w+) in fs.open.

 - fs.open now uses the new handle types, and supports update (r+, w+)
   mode.

 - http.request now uses the new readable handle type. We no longer
   encode the request body to UTF-8, nor decode the response from UTF-8.

 - Websockets now return text frame's contents directly, rather than
   converting it from UTF-8. Sending text frames now attempts to treat
   the passed string as UTF-8, rather than treating it as latin1.
2023-11-08 19:40:14 +00:00
..
events Always use raw bytes in file handles 2023-11-08 19:40:14 +00:00
guides Always use raw bytes in file handles 2023-11-08 19:40:14 +00:00
images Document setting up a gps constellation (#1070) 2022-07-02 10:09:38 +01:00
reference Always use raw bytes in file handles 2023-11-08 19:40:14 +00:00
stub Use standard Markdown link syntax for references 2023-08-24 11:23:33 +01:00
head.html License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
index.md Bump illuaminate version 2023-08-23 18:09:26 +01:00
logo-darkmode.png Add dark-mode compatible logo to README (#1521) 2023-07-18 19:26:45 +00:00
logo.png Optimise CC:T logo 2021-09-26 10:26:42 +01:00
mod-page.md Fix image links in Modrinth description 2023-05-24 22:35:45 +01:00