#traits #extension #impl #methods #annotations #custom

extension-traits

Annotation to easily define ad-hoc / one-shot extension traits

4 releases (stable)

2.0.0 Jul 11, 2024
2.0.0-rc1 Jul 10, 2024
1.0.1 Jan 18, 2022

#1126 in Rust patterns

Download history 17162/week @ 2024-08-19 19638/week @ 2024-08-26 17887/week @ 2024-09-02 16782/week @ 2024-09-09 15909/week @ 2024-09-16 18783/week @ 2024-09-23 19819/week @ 2024-09-30 17820/week @ 2024-10-07 20087/week @ 2024-10-14 23480/week @ 2024-10-21 20782/week @ 2024-10-28 22301/week @ 2024-11-04 18738/week @ 2024-11-11 22443/week @ 2024-11-18 28725/week @ 2024-11-25 39324/week @ 2024-12-02

109,807 downloads per month
Used in 62 crates (7 directly)

Zlib OR MIT OR Apache-2.0

15KB
53 lines

::extension-traits

Annotation to easily define ad-hoc / one-shot extension traits.

Repository Latest version Documentation MSRV unsafe forbidden License CI

Examples

  • Also

    #[macro_use]
    extern crate extension_traits;
    
    #[extension(trait Also)]
    impl<T> T {
        fn also (mut self, f: impl FnOnce(&mut Self))
          -> Self
        {
            f(&mut self);
            self
        }
    }
    
    fn main ()
    {
        use ::std::{collections::HashMap, ops::Not};
    
        let /* immut */ map = HashMap::with_capacity(2).also(|m| {
            m.insert("foo", 42);
            m.insert("bar", 27);
        });
        assert!(map.contains_key("foo"));
        assert!(map.contains_key("bar"));
        assert!(map.contains_key("baz").not());
    }
    
  • WithPath

    #[macro_use]
    extern crate extension_traits;
    
    use ::std::{error::Error, path::{Path, PathBuf}};
    
    #[extension(trait WithPath)]
    impl PathBuf {
        fn with (mut self, segment: impl AsRef<Path>)
          -> PathBuf
        {
            self.push(segment);
            self
        }
    }
    
    fn main ()
      -> Result<(), Box<dyn Error>>
    {
        let some_dir = PathBuf::from(::std::env::var("MY_LIB_SOME_DIR")?);
        // Contrary to chaining `.join()`, this reuses the memory!
        let some_subdir = some_dir.with("some").with("sub").with("dir");
        //
        Ok(())
    }
    
  • Context

    #[macro_use]
    extern crate extension_traits;
    
    use ::std::{error::Error, fmt::Display};
    
    #[extension(trait Context)]
    impl<Ok, Err : Display> Result<Ok, Err> {
        fn context (self, prefix: impl Display)
          -> Result<Ok, String>
        {
            self.map_err(|err| format!("{}: {}", prefix, err))
        }
    }
    
    fn main ()
      -> Result<(), Box<dyn Error>>
    {
        let file_contents =
            ::std::fs::read_to_string("some/file")
                .context("Error when opening some/file")?
        ;
        //
        Ok(())
    }
    

Similar to https://docs.rs/extension-trait, but for the following:

Features

  • Supports generics (see Context)

  • search/grep 'trait TraitName'-friendly!

Dependencies

~1.5MB
~37K SLoC