Skip to content

docs(nx-object): record the read coverage the crate now has - #15

Merged
LNSD merged 1 commit into
mainfrom
lnsd/readme-read-coverage
Aug 18, 2026
Merged

LNSD merged 1 commit into
mainfrom
lnsd/readme-read-coverage

Conversation

@LNSD

@LNSD LNSD commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

The format table and the scope note were written when the crate could only build KIP, PFS0, NCA, and CNMT. All four are readable now, and one of the stated limits is no longer true, so a reader deciding whether to depend on the crate was being told less than it does.

  • Tick the read column for KIP, PFS0, NCA, and CNMT
  • Replace the claim that the crate does not decompress with what it actually does: expanding is offered, but as a separate allocating call rather than behind an accessor
  • Say that reading an NCA takes an already-decrypted buffer, which is the same split the write side documents from the other direction

The format table and the scope note were written when the crate could only build KIP, PFS0, NCA, and CNMT. All four are readable now, and one of the stated limits is no longer true, so a reader deciding whether to depend on the crate was being told less than it does.

- Tick the `read` column for KIP, PFS0, NCA, and CNMT
- Replace the claim that the crate does not decompress with what it actually does: expanding is offered, but as a separate allocating call rather than behind an accessor
- Say that reading an NCA takes an already-decrypted buffer, which is the same split the write side documents from the other direction

Signed-off-by: Lorenzo Delgado <lnsdev@proton.me>
@LNSD
LNSD added this pull request to the merge queue Aug 18, 2026
Merged via the queue into main with commit 03911ee Aug 18, 2026
5 checks passed
@LNSD
LNSD deleted the lnsd/readme-read-coverage branch August 18, 2026 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant