Skip to content

Commit

Permalink
Doc: update rust information of STD
Browse files Browse the repository at this point in the history
Signed-off-by: ivila <[email protected]>
Reviewed-by: Sumit Garg <[email protected]>
Reviewed-by: Yuan Zhuang <[email protected]>
  • Loading branch information
ivila authored and DemesneGH committed Jan 20, 2025
1 parent dd1a754 commit 29972a9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ TrustZone applications with Rust's standard library (std) and many third-party
libraries (i.e., crates). Teaclave TrustZone SDK is a sub-project of [Apache
Teaclave (incubating)](https://teaclave.apache.org/).

Teaclave TrustZone SDK provides two development modes for Rust TAs: `no-std` and `std`.
Teaclave TrustZone SDK provides two development modes for Rust TAs: `no-std`
and `std`.
We recommend using `no-std` by default. For a detailed comparison, please refer
to [Comparison](#comparison).

Expand Down Expand Up @@ -60,18 +61,20 @@ branch (`main`), please refer to the
- Substantial reduction in binary size.

- **Cons**:
- Limited support for third-party crates. In the no-std mode, Trusted Applications
(TAs) are unable to utilize crates dependent on the standard library (std).
- Limited support for third-party crates. In the no-std mode, Trusted
Applications (TAs) are unable to utilize crates dependent on the standard
library (std).

#### `std`

- **Pros**:
- Enables the utilization of more third-party crates, including those requiring
`std`, such as `serde_json` and `rustls`, which are essential for functionality.
- Enables the utilization of more third-party crates, including those
requiring `std`, such as `rustls`, which are essential for functionality.

- **Cons**:
- Manual porting of `std` with infrequent updates. Currently using `std` version
`1.56.1` and `Rust` version `nightly-2021-09-20`. (Planned to update)
- Manual porting of `std` with infrequent updates. Currently using `std`
version `1.80.0` and `Rust` version `nightly-2024-05-14`, which might not
meet the MSRV requirements of some crates.

### Supported Examples

Expand Down

0 comments on commit 29972a9

Please sign in to comment.