pseudonym's Introduction

pseudonym 🕵️

Declare aliases for Rust constructs with ease!

[dependencies]
pseudonym = "0.2.2"

Usage

In the following examples the items to which the macro is attached to get generated as aliases using the passed identifier.

Functions

use pseudonym::alias;

#[alias(short_name)]
fn very_long_function_name() {
    // ...
}

fn main () {
    short_name(); // use the alias!
}

Structures

use pseudonym::alias;

#[alias(StructAlias)]
struct S (i32);

Traits

use pseudonym::alias;

#[alias(TraitAlias)]
trait T {}

Implementations

use pseudonym::alias;

#[alias(StructAlias)]
struct S;

#[alias(StructAlias)]
impl S {
    fn new() -> Self { Self }
}

Constants

use pseudonym::alias;

#[alias(ConstAlias)]
const foo: usize = 0;

Deprecating Aliases

Sometimes, you'll need to create aliases to old functions which are deprecated. pseudonym allows you to deprecate aliases using the same syntax as deprecated.

use pseudonym::alias;

#[alias(
    deprecated(
        old_api_function,
        since = "0.1.0",
        note = "This function has been deprecated in favor of `new_api_function`"
    )
)]
fn new_api_function() {
    // ...
}

fn main () {
    old_api_function(); // use the alias!
}

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 this project by you, as defined in the Apache-2.0 license,
shall be dual licensed as above, without any additional terms or conditions.}

pseudonym's People

Contributors

Stargazers

Watchers

pseudonym's Issues

jmg-duarte / pseudonym Goto Github PK