Skip to content

Explain postgrestd in README #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 27, 2022
Merged

Explain postgrestd in README #61

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03a2876
Explain postgrestd in README
Jul 25, 2022
caa3f6a
Automatically enable postgrestd
Jul 26, 2022
5264be9
Revert "Automatically enable postgrestd"
Jul 26, 2022
f5684c2
Note target_postgrestd in README
Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,23 @@ Option | Description
[github-fpm]: https://github.com/jordansissel/fpm
[docs-rs-tracing-directive]: https://docs.rs/tracing-subscriber/0.3.11/tracing_subscriber/filter/struct.EnvFilter.html

# Using PL/Rust with Postgrestd
PL/Rust currently supports being used with an experimental fork of Rust's std entitled `postgrestd` which supports an
`x86_64-unknown-linux-postgres` target. This is built via the `build` script, which pulls in `postgrestd`.
Doing so places a copy of the necessary libraries used by Rust for `std` into the appropriate "sysroot",
which is the location that rustc will look for building those libraries.

Further usage requires setting the `PLRUST_TARGET` to the appropriate tuple, as this is still an experimental feature,
and so is not currently set by default. Passing `--features target_postgrestd` to `cargo` also works.

This initial build process requires a normal installation of Rust via [`rustup`](https://rustup.rs)
and for the relevant location to be writeable on the building host.

```bash
cd plrust
./build
PLRUST_TARGET="x86_64-unknown-linux-postgres" cargo build
```

# Installation

Expand Down