nextcloud-docs/rust/README.md

Note: this is the "per-architecture" repository for the arm32v5 builds of the rust official image -- for more information, see "Architectures other than amd64?" in the official images documentation and "An image's source changed in Git, now what?" in the official images FAQ.

Quick reference

• Maintained by:
  the Rust Project developers

• Where to get help:
  the Docker Community Slack, Server Fault, Unix & Linux, or Stack Overflow

Supported tags and respective Dockerfile links

WARNING: THIS IMAGE IS NOT SUPPORTED ON THE arm32v5 ARCHITECTURE

Quick reference (cont.)

• Where to file issues:
  https://github.com/rust-lang/docker-rust/issues

• Supported architectures: (more info)
  amd64, arm32v7, arm64v8, i386, ppc64le, riscv64, s390x

• Published image artifact details:
  repo-info repo's repos/rust/ directory (history)
  (image metadata, transfer size, etc)

• Image updates:
  official-images repo's library/rust label
  official-images repo's library/rust file (history)

• Source of this description:
  docs repo's rust/ directory (history)

What is Rust?

Rust is a systems programming language sponsored by Mozilla Research. It is designed to be a "safe, concurrent, practical language", supporting functional and imperative-procedural paradigms. Rust is syntactically similar to C++, but is designed for better memory safety while maintaining performance.

wikipedia.org/wiki/Rust_(programming_language)

How to use this image

Start a Rust instance running your app

The most straightforward way to use this image is to use a Rust container as both the build and runtime environment. In your Dockerfile, writing something along the lines of the following will compile and run your project:

FROM arm32v5/rust:1.67

WORKDIR /usr/src/myapp
COPY . .

RUN cargo install --path .

CMD ["myapp"]

Then, build and run the Docker image:

$ docker build -t my-rust-app .
$ docker run -it --rm --name my-running-app my-rust-app

This creates an image that has all of the rust tooling for the image, which is 1.8gb. If you just want the compiled application:

FROM rust:1.67 as builder
WORKDIR /usr/src/myapp
COPY . .
RUN cargo install --path .

FROM debian:bullseye-slim
RUN apt-get update && apt-get install -y extra-runtime-dependencies && rm -rf /var/lib/apt/lists/*
COPY --from=builder /usr/local/cargo/bin/myapp /usr/local/bin/myapp
CMD ["myapp"]

Note: Some shared libraries may need to be installed as shown in the installation of the extra-runtime-dependencies line above.

This method will create an image that is less than 200mb. If you switch to using the Alpine-based rust image, you might be able to save another 60mb.

See https://docs.docker.com/develop/develop-images/multistage-build/ for more information.

Compile your app inside the Docker container

There may be occasions where it is not appropriate to run your app inside a container. To compile, but not run your app inside the Docker instance, you can write something like:

$ docker run --rm --user "$(id -u)":"$(id -g)" -v "$PWD":/usr/src/myapp -w /usr/src/myapp arm32v5/rust:1.23.0 cargo build --release

This will add your current directory, as a volume, to the container, set the working directory to the volume, and run the command cargo build --release. This tells Cargo, Rust's build system, to compile the crate in myapp and output the executable to target/release/myapp.

License

View license information for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be auto-detected might be found in the repo-info repository's rust/ directory.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.