GitXplorerGitXplorer
t

easy-ext

public
48 stars
2 forks
3 issues

Commits

List of commits on branch main.
Unverified
f603dd83359cd2f2136f986a22c7ca04c339adfc

ci: Use -Zmiri-many-seeds on scheduled job

ttaiki-e committed 8 days ago
Unverified
fb12ad94afffc6da0d51c5700fbac3413d814f33

tools: Update tidy.sh and markdownlint config

ttaiki-e committed 8 days ago
Unverified
02927588300523f6cddeb87eacf7abfbfd57aa82

tests: Use native async fn in trait in syntax test

ttaiki-e committed 11 days ago
Unverified
38281f1e2dbfb9865c19da9e6458ba3ce1320baf

Apply unnameable_types lint

ttaiki-e committed 12 days ago
Unverified
becdbb66c5d41800a2bab87c76468da1f5fe1acd

Update changelog

ttaiki-e committed 3 months ago
Unverified
6d877edb77f3761452319102a2c31cdc025d7af9

ci: Auto-update cspell dictionary

ttaiki-e committed 3 months 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.