README example does not compile

Open Beginner friendly
#378 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

Locate the failing code example in README and reproduce its compilation errors in the example's stated context. Check the example's imports and dependency declarations, then confirm that it compiles without the reported warnings or unresolved byteorder error.

Written by the indexing model from the issue text.

Description

The example in the README fails to compile with the following errors and warnings:

warning: unused import: `std::fs`
  --> src/main.rs:15:5
   |
15 | use std::fs;
   |     ^^^^^^^
   |
   = note: `#[warn(unused_imports)]` (part of `#[warn(unused)]`) on by default

warning: unused import: `std::path::Path`
  --> src/main.rs:16:5
   |
16 | use std::path::Path;
   |     ^^^^^^^^^^^^^^^

error[E0433]: cannot find module or crate `byteorder` in this scope
  --> src/main.rs:25:31
   |
25 | ...Str, U32<byteorder::NativeEndian>> = env.create_database(&mut wtxn, None)?;
   |             ^^^^^^^^^ use of unresolved module or unlinked crate `byteorder`
   |
   = help: if you wanted to use a crate named `byteorder`, use `cargo add byteorder` to add it to your `Cargo.toml`
Dominant language
Rust
Stars
915
Forks
82
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from meilisearch/heed

All issues in meilisearch/heed

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.