mirror of
https://git.asonix.dog/asonix/activitystreams.git
synced 2024-11-22 11:51:00 +00:00
132 lines
4.2 KiB
Markdown
132 lines
4.2 KiB
Markdown
# ActivityStreams
|
|
__A set of Traits and Types that make up the Activity Streams specification__
|
|
|
|
- [Read the documentation on docs.rs](https://docs.rs/activitystreams)
|
|
- [Find the crate on crates.io](https://crates.io/crates/activitystreams)
|
|
- [Join the discussion on Matrix](https://matrix.to/#/!fAEcHyTUdAaKCzIKCt:asonix.dog?via=asonix.dog)
|
|
|
|
## Usage
|
|
|
|
### Basic usage
|
|
For basic use, add the following to your Cargo.toml
|
|
```toml
|
|
# Cargo.toml
|
|
|
|
activitystreams = "0.3"
|
|
```
|
|
|
|
And then use it in your project
|
|
```rust
|
|
use activitystreams::{context, Object, Actor, object::Profile};
|
|
use serde_derive::{Serialize, Deserialize};
|
|
|
|
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct Persona {
|
|
#[serde(rename = "@context")]
|
|
context: serde_json::Value,
|
|
|
|
#[serde(rename = "type")]
|
|
kind: String,
|
|
}
|
|
|
|
impl Object for Persona {}
|
|
impl Actor for Persona {}
|
|
|
|
fn run() -> Result<(), anyhow::Error> {
|
|
let mut profile = Profile::default();
|
|
|
|
profile.profile.set_describes_object(Persona {
|
|
context: serde_json::to_value(context())?,
|
|
|
|
kind: "Persona".to_owned(),
|
|
})?;
|
|
|
|
profile.object_props.set_context_object(context())?;
|
|
|
|
let profile_string = serde_json::to_string(&profile)?;
|
|
|
|
let profile: Profile = serde_json::from_str(&profile_string)?;
|
|
|
|
Ok(())
|
|
}
|
|
```
|
|
|
|
### Advanced Usage
|
|
Add the required crates to your `Cargo.toml`
|
|
```toml
|
|
# Cargo.toml
|
|
|
|
activitystreams-derive = "0.2"
|
|
activitystreams-traits = "0.2"
|
|
activtystreams-types = "0.3"
|
|
serde = "1.0"
|
|
serde_derive = "1.0"
|
|
serde_json = "1.0"
|
|
```
|
|
|
|
And then in your project
|
|
```rust
|
|
use activitystreams_derive::{Properties, UnitString};
|
|
use activitystreams_traits::{Link, Object};
|
|
use activitystreams_types::{CustomLink, link::Mention};
|
|
use serde_derive::{Deserialize, Serialize};
|
|
|
|
/// Using the UnitString derive macro
|
|
///
|
|
/// This macro implements Serialize and Deserialize for the given type, making this type
|
|
/// represent the string "SomeKind" in JSON.
|
|
#[derive(Clone, Debug, Default, UnitString)]
|
|
#[activitystreams(SomeKind)]
|
|
pub struct MyKind;
|
|
|
|
/// Using the Properties derive macro
|
|
///
|
|
/// This macro generates getters and setters for the associated fields.
|
|
#[derive(Clone, Debug, Default, Deserialize, Serialize, Properties)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct MyProperties {
|
|
/// Derive getters and setters for @context with Link and Object traits.
|
|
#[serde(rename = "@context")]
|
|
#[activitystreams(ab(Object, Link))]
|
|
pub context: Option<serde_json::Value>,
|
|
|
|
/// Use the UnitString MyKind to enforce the type of the object by "SomeKind"
|
|
pub kind: MyKind,
|
|
|
|
/// Derive getters and setters for required_key with String type.
|
|
///
|
|
/// In the Activity Streams spec, 'functional' means there can only be one item for this
|
|
/// key. This means all fields not labeled 'functional' can also be serialized/deserialized
|
|
/// as Vec<T>.
|
|
#[activitystreams(concrete(String), functional)]
|
|
pub required_key: serde_json::Value,
|
|
}
|
|
|
|
fn run() -> Result<(), anyhow::Error> {
|
|
let mut props = MyProperties::default();
|
|
|
|
props.set_required_key_string("Hey".to_owned())?;
|
|
|
|
let my_link = CustomLink::new(Mention::default(), props);
|
|
|
|
let my_link_string = serde_json::to_string(&my_link)?;
|
|
|
|
let my_link: CustomLink<Mention, MyProperties> = serde_json::from_str(&my_link_string)?;
|
|
|
|
Ok(())
|
|
}
|
|
```
|
|
|
|
## Contributing
|
|
Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the GPLv3.
|
|
|
|
## License
|
|
|
|
Copyright © 2018 Riley Trautman
|
|
|
|
ActivityStreams is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
|
|
|
ActivityStreams is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of ActivityStreams.
|
|
|
|
You should have received a copy of the GNU General Public License along with ActivityStreams. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
|