Skip to content

Commit

Permalink
Merge pull request #21 from alecmocatta/bump-relative
Browse files Browse the repository at this point in the history
Bump to relative 0.2
  • Loading branch information
alecmocatta committed Oct 18, 2019
2 parents 2dcd236 + f8304ef commit e372d94
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 15 deletions.
10 changes: 4 additions & 6 deletions .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,10 @@ pull_request_rules:
conditions:
- base=master
- status-success=tests
- label!=work-in-progress
- "label!=work in progress"
- "#approved-reviews-by>=1"
- "#review-requested=0"
- "#changes-requested-reviews-by=0"
- "#commented-reviews-by=0"
actions:
merge:
method: merge
Expand All @@ -17,11 +16,10 @@ pull_request_rules:
conditions:
- base=master
- status-success=tests
- label!=work-in-progress
- "label!=work in progress"
- author=alecmocatta # https://github.com/Mergifyio/mergify-engine/issues/451
- "#review-requested=0"
- "#changes-requested-reviews-by=0"
- "#commented-reviews-by=0"
actions:
merge:
method: merge
Expand All @@ -36,10 +34,10 @@ pull_request_rules:
- "title~=^WIP: .*"
actions:
label:
add: ["work-in-progress"]
add: ["work in progress"]
- name: auto remove wip label
conditions:
- "-title~=^WIP: .*"
actions:
label:
remove: ["work-in-progress"]
remove: ["work in progress"]
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "serde_traitobject"
version = "0.2.0"
version = "0.2.1"
license = "MIT OR Apache-2.0"
authors = ["Alec Mocatta <[email protected]>"]
categories = ["development-tools","encoding","rust-patterns","network-programming"]
Expand All @@ -12,7 +12,7 @@ This library enables the serialization and deserialization of trait objects such
"""
repository = "https://github.com/alecmocatta/serde_traitobject"
homepage = "https://github.com/alecmocatta/serde_traitobject"
documentation = "https://docs.rs/serde_traitobject/0.2.0"
documentation = "https://docs.rs/serde_traitobject/0.2.1"
readme = "README.md"
edition = "2018"

Expand All @@ -24,7 +24,7 @@ maintenance = { status = "actively-developed" }
serde = "1.0"
erased-serde = "0.3"
metatype = "0.2"
relative = "0.1.2"
relative = "0.2"

[dev-dependencies]
serde_derive = "1.0"
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
[![MIT / Apache 2.0 licensed](https://img.shields.io/crates/l/serde_traitobject.svg?maxAge=2592000)](#License)
[![Build Status](https://dev.azure.com/alecmocatta/serde_traitobject/_apis/build/status/tests?branchName=master)](https://dev.azure.com/alecmocatta/serde_traitobject/_build/latest?branchName=master)

[Docs](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/)
[Docs](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/)

**Serializable and deserializable trait objects.**

This library enables the serialization and deserialization of trait objects so they can be sent between other processes running the same binary.

For example, if you have multiple forks of a process, or the same binary running on each of a cluster of machines, this library lets you send trait objects between them.

Any trait can be made (de)serializable when made into a trait object by adding this crate's [Serialize](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Serialize.html) and [Deserialize](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Deserialize.html) traits as supertraits:
Any trait can be made (de)serializable when made into a trait object by adding this crate's [Serialize](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Serialize.html) and [Deserialize](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Deserialize.html) traits as supertraits:

```rust
trait MyTrait: serde_traitobject::Serialize + serde_traitobject::Deserialize {
Expand All @@ -28,12 +28,12 @@ struct Message(#[serde(with = "serde_traitobject")] Box<dyn MyTrait>);
And that's it! The two traits are automatically implemented for all `T: serde::Serialize` and all `T: serde::de::DeserializeOwned`, so as long as all implementors of your trait are themselves serializable then you're good to go.

There are two ways to (de)serialize your trait object:
* Apply the `#[serde(with = "serde_traitobject")]` [field attribute](https://serde.rs/attributes.html), which instructs serde to use this crate's [serialize](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/fn.serialize.html) and [deserialize](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/fn.deserialize.html) functions;
* The [Box](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/struct.Box.html), [Rc](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/struct.Rc.html) and [Arc](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/struct.Arc.html) structs, which are simple wrappers around their stdlib counterparts that automatically handle (de)serialization without needing the above annotation;
* Apply the `#[serde(with = "serde_traitobject")]` [field attribute](https://serde.rs/attributes.html), which instructs serde to use this crate's [serialize](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/fn.serialize.html) and [deserialize](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/fn.deserialize.html) functions;
* The [Box](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/struct.Box.html), [Rc](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/struct.Rc.html) and [Arc](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/struct.Arc.html) structs, which are simple wrappers around their stdlib counterparts that automatically handle (de)serialization without needing the above annotation;

Additionally, there are several convenience traits implemented that extend their stdlib counterparts:

* [Any](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Any.html), [Debug](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Debug.html), [Display](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Display.html), [Error](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Error.html), [Fn](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.Fn.html), [FnMut](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.FnMut.html), [FnOnce](https://docs.rs/serde_traitobject/0.2.0/serde_traitobject/trait.FnOnce.html)
* [Any](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Any.html), [Debug](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Debug.html), [Display](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Display.html), [Error](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Error.html), [Fn](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.Fn.html), [FnMut](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.FnMut.html), [FnOnce](https://docs.rs/serde_traitobject/0.2.1/serde_traitobject/trait.FnOnce.html)

These are automatically implemented on all implementors of their stdlib counterparts that also implement `serde::Serialize` and `serde::de::DeserializeOwned`.

Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
//!
//! This crate currently requires Rust nightly.

#![doc(html_root_url = "https://docs.rs/serde_traitobject/0.2.0")]
#![doc(html_root_url = "https://docs.rs/serde_traitobject/0.2.1")]
#![feature(
arbitrary_self_types,
coerce_unsized,
Expand Down

0 comments on commit e372d94

Please sign in to comment.