override_macro

Crates.iooverride_macro
lib.rsoverride_macro
version0.1.0
sourcesrc
created_at2024-11-17 17:12:43.141048
updated_at2024-11-17 17:12:43.141048
descriptionAn attribute-like macro for Rust programs to override trait methods with default methods of other traits
homepage
repositoryhttps://github.com/sttk/override_macro-rust
max_upload_size
id1451410
size29,334
Takayuki Sato (sttk)

documentation

https://docs.rs/override_macro

README

override_macro-rust crate.io doc.rs CI Status MIT License

This crate provides attribute-like macros to override trait methods with other traits for a structs or another trait.

Install

In Cargo.toml, write this crate as a dependency.

[dependencies]
override_macro = "0.1.0"

Usage

First, by using overridable attribute macro, collects trait informations whose methods override methods of other trait and are overridden with methods of other traits.

The argument of this attribute macro is to specify the module path. This argument is optional but it is better to specify it because the trait name may be conflict to other traits.

use override_macro::overridable;

#[overridable(mod = crate::module::path01)]
trait Trait1 {
    fn method1(&self, b: bool) -> u64;
}
use override_macro::overridable;

#[overridable(mod = crate::module::path02)]
trait Trait2 {
    fn method1(&self, b: bool) -> u64 {
        ...
    }
}

Next, by using override_with attribute macro, adds overridiing methods of the target trait for a struct or a trait.

The arguments of this attribute-macro are paths of traits having overriding methods. This attribute-macro searches for methods with the same sigunature to the methods in the target trait from the traits passed as the arguments, and then adds these method callings to the target trait.

use override_macro::override_with;

struct StructA;
impl Trait02 for StructA {}

#[override_with(crate::module::path02::Trait2)]
impl Trait01 for StructA {}

Supporting Rust versions

This crate supports Rust 1.80.1 or later.

% cargo msrv --no-check-feedback
Fetching index
Determining the Minimum Supported Rust Version (MSRV) for toolchain x86_64-apple-darwin
Using check command cargo check
   Finished The MSRV is: 1.80.1   ████████████████████████████████████████████ 00:00:36

License

Copyright (C) 2024 Takayuki Sato

This program is free software under MIT License.
See the file LICENSE in this distribution for more details.

Commit count: 8

cargo fmt