• 0 Posts
  • 14 Comments
Joined 3 years ago
cake
Cake day: July 9th, 2023

help-circle
  • Here is an originally random list (using cargo tree --prefix=depth) with some very loose logical grouping. Wide-scoped and well-known crates removed (some remaining are probably still known by most).

    mime data-encoding percent-encoding textwrap unescape unicode-width scraper
    arrayvec bimap bstr enum-iterator os_str_bytes pretty_assertions paste
    clap_complete console indicatif shlex
    lz4_flex mpeg2ts roxmltree speedy
    aes base64 hex cbc sha1 sha2 rsa
    reverse_geocoder trust-dns-resolver
    signal-hook signal-hook-tokio
    blocking
    fs2
    semver
    snmalloc-rs
    




  • are there any hurdles or other good reasons to not just adding this to every create?

    I’m no expert. But my guess would be that many crate authors may simply not be aware of this feature. It wasn’t always there, and it’s still unstable. You would have to reach the “Unstable features” page of the rustdoc book to know about it.

    Or maybe some know about it, but don’t want to use an unstable feature, or are just waiting for it to possibly automatically work without any modifications.

    Of course, I would assume none of this applies to the embassy devs. That Cargo.toml file has a flavors field, which is something I’ve never seen before 😉 So, I’m assuming they are way more knowledgable (and up-to-date) about the Rust ecosystem than me.


  • So, this is being worked on. But for now, that crate needs this line in lib.rs

    #![cfg_attr(docsrs, feature(doc_auto_cfg))]
    

    And this line in Cargo.toml’s [package.metadata.docs.rs] section:

    rustdoc-args = ["--cfg", "docsrs"]
    

    With these changes, feature gating will be displayed in the docs.

    To replicate this locally:

    RUSTDOCFLAGS='--cfg docsrs' cargo doc --features=nightly,defmt,pender-callback,arch-cortex-m,executor-thread,executor-interrupt
    

  • I constantly seem to include something from the docs, only to be told by the compiler that it does not exist, and then I have to open the source for the create to figure out if it’s hidden behind a feature flag.

    As others mentioned, the situation is not perfect. And you may need to check Cargo.toml. Maybe even the source.

    But as for the quoted part above, the docs should definitely indicate if a part of the API is behind a feature. Let’s take rustix as an example.

    Here is the module list:

    Here is the view from inside a module:

    Here is the view from a function page:

    This is also true for platform support. Take this extension trait from std:

    Now, it’s true that one could be navigating to method docs in the middle of a long doc page, where those indicators at the top may be missed. But that’s a UI issue. And it could be argued that repeating those indicators over and over would introduce too much clutter.


  • Note: the ᐸᐳ characters used below are Canadian Aboriginal syllabics because Lemmy devs haven’t fixed broken input sanitization yet.


    Well, getters are not an official concept in Rust. You can do whatever works best in your case.

    Just worth pointing out that a method with a return value of OptionVecStringᐳᐳ wouldn’t be really a getter, as you must be constructing values, or moving ownership, or cloning. None of these actions conceptually belong to a getter.

    Also, you should be clear on the what the Option abstraction means. Does it mean the vector is empty? Does it mean the vector does not exist or some sort of null (FFI ore serialization contexts)? And make sure the code does what you expect it to do.



    • I would drop the derive shorthands, and drop the Cypher prefix from the derive macros. They are already namespaced under the crate.
    • Regarding the ty::new() impls, I’m not a hardline devotee of the builder pattern, but when there are multiple private fields of the same type, I would absolutely prefer it, to remove the possibility of field-value confusion at construction.

    I didn’t dig deeper because I noticed you posted this to Reddit first 😉



  • Discriminant is irrelevant and you’re not supposed to fuck with it.

    And there is zero reason to use unsafe/transmute for this.

    pub enum LibErr {
        ErrX,
        ErrY,
        ErrZ,
        Unknown(i32),
    }
    
    struct RetVal(i32);
    
    impl From<RetVal> for Result<i32, LibErr> {
        fn from(RetVal(ret_val): RetVal) -> Self {
            if ret_val < 0 {
                match ret_val {
                    -1 => Err(LibErr::ErrX),
                    -2 => Err(LibErr::ErrY),
                    -3 => Err(LibErr::ErrZ),
                    unknown => Err(LibErr::Unknown(unknown)),
                }
            } else { Ok(ret_val) }
        }
    }
    
    // RetVal(call_function()).into()