GitXplorerGitXplorer
t

easy-ext

public
48 stars
2 forks
3 issues

Commits

List of commits on branch main.
Unverified
4ad9bd112f538a1f4503ad31d779a99512374339

ci: Disable buggy dependabot grouped update

ttaiki-e committed 2 days ago
Unverified
43c584a7ecad2ea18d790d848f85ad10f283e819

tools: Format shell scripts with indent_size = 2 to match scripts in CI config

ttaiki-e committed 2 days ago
Unverified
22f7b7fda754bf636036e87902f173fedca991f1

tests: Remove needless semicolon

ttaiki-e committed 3 days ago
Unverified
74c42b269dfc0811229f03e09e42576423d953e9

Update rust-lang/rust links

ttaiki-e committed 4 days ago
Unverified
fcd37f887432870ea74a5dd5c577db6c08bff1a3

Apply clippy::unused_trait_names lint

ttaiki-e committed 5 days ago
Unverified
fea94a315ad7b2556bb438b7fd063c197542eac7

ci: Update reusable workflows

ttaiki-e committed 6 days ago

README

The README file for this repository.

easy-ext

crates.io docs.rs license msrv github actions

A lightweight attribute macro for easily writing extension trait pattern.

[dependencies]
easy-ext = "1"

Examples

use easy_ext::ext;

#[ext(ResultExt)]
pub impl<T, E> Result<T, E> {
    fn err_into<U>(self) -> Result<T, U>
    where
        E: Into<U>,
    {
        self.map_err(Into::into)
    }
}

Code like this will be generated:

pub trait ResultExt<T, E> {
    fn err_into<U>(self) -> Result<T, U>
    where
        E: Into<U>;
}

impl<T, E> ResultExt<T, E> for Result<T, E> {
    fn err_into<U>(self) -> Result<T, U>
    where
        E: Into<U>,
    {
        self.map_err(Into::into)
    }
}

You can elide the trait name.

use easy_ext::ext;

#[ext]
impl<T, E> Result<T, E> {
    fn err_into<U>(self) -> Result<T, U>
    where
        E: Into<U>,
    {
        self.map_err(Into::into)
    }
}

Note that in this case, #[ext] assigns a random name, so you cannot import/export the generated trait.

Visibility

There are two ways to specify visibility.

Impl-level visibility

The first way is to specify visibility at the impl level. For example:

use easy_ext::ext;

// unnamed
#[ext]
pub impl str {
    fn foo(&self) {}
}

// named
#[ext(StrExt)]
pub impl str {
    fn bar(&self) {}
}

Associated-item-level visibility

Another way is to specify visibility at the associated item level.

For example, if the method is pub then the trait will also be pub:

use easy_ext::ext;

#[ext(ResultExt)] // generate `pub trait ResultExt`
impl<T, E> Result<T, E> {
    pub fn err_into<U>(self) -> Result<T, U>
    where
        E: Into<U>,
    {
        self.map_err(Into::into)
    }
}

This is useful when migrate from an inherent impl to an extension trait.

Note that the visibility of all the associated items in the impl must be identical.

Note that you cannot specify impl-level visibility and associated-item-level visibility at the same time.

If you want the extension trait to be a subtrait of another trait, add Self: SubTrait bound to the where clause.

use easy_ext::ext;

#[ext(Ext)]
impl<T> T
where
    Self: Default,
{
    fn method(&self) {}
}

Supported items

use easy_ext::ext;

#[ext]
impl<T> T {
    fn method(&self) {}
}
use easy_ext::ext;

#[ext]
impl<T> T {
    const MSG: &'static str = "Hello!";
}
use easy_ext::ext;

#[ext]
impl str {
    type Owned = String;

    fn method(&self) -> Self::Owned {
        self.to_owned()
    }
}

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.