actpub-activitystreams 0.2.0

//! Activity Streams 2.0 data model and vocabulary.
//!
//! This crate provides pure data types (no I/O, no networking) for the W3C
//! [Activity Streams 2.0 Core] and [Activity Vocabulary] specifications, as
//! used by the [ActivityPub] protocol.
//!
//! # Design
//!
//! The types are designed for idiomatic `serde` (de)serialization with
//! tolerant handling of the JSON-LD variants emitted by real-world Fediverse
//! implementations such as Mastodon, Pleroma, Lemmy and Misskey.
//!
//! Core AS 2.0 types ([`Object`], [`Link`], [`Activity`], [`Collection`]) are
//! concrete structs with every specification-defined property represented as
//! `Option<T>` or [`OneOrMany<T>`]. Concrete vocabulary types that add no new
//! properties (`Note`, `Article`, `Create`, …) share the core structs and are
//! discriminated by string type constants ([`kind`]), while types that add
//! new properties (`Question`, `Place`, `Tombstone`) are provided as
//! dedicated structs that flatten the core object.
//!
//! # Interoperability
//!
//! Real Fediverse JSON-LD is inconsistent and requires tolerance:
//!
//! - Array-typed properties may appear as a single value (handled by
//!   [`OneOrMany<T>`])
//! - Object properties may be inlined or appear as plain URL strings (handled
//!   by [`UrlOr<T>`])
//! - The [`Public`] audience appears in multiple equivalent forms
//! - Unknown properties are preserved via flattened extension maps
//!
//! [Activity Streams 2.0 Core]: https://www.w3.org/TR/activitystreams-core/
//! [Activity Vocabulary]: https://www.w3.org/TR/activitystreams-vocabulary/
//! [ActivityPub]: https://www.w3.org/TR/activitypub/
#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(
    clippy::error_impl_error,
    reason = "`Error` is the idiomatic name for the crate's top-level error enum, matching the `thiserror` convention used pervasively in the Rust ecosystem"
)]
#![cfg_attr(
    test,
    allow(
        clippy::indexing_slicing,
        reason = "JSON field indexing via `Value[\"key\"]` is ergonomic inside tests and its panic-on-missing behaviour is the desired failure mode when fixtures are wrong"
    )
)]

mod actor;
mod context;
mod error;
mod link;
mod multikey;
mod object;
mod proof;
mod value;

pub mod kind;

pub use self::actor::{Endpoints, PublicKey};
pub use self::context::{Context, ContextEntry, WithContext};
pub use self::error::Error;
pub use self::link::Link;
pub use self::multikey::{AssertionMethod, Multikey};
pub use self::object::{LanguageMap, Object, ObjectRef};
pub use self::proof::Proof;
pub use self::value::{HasId, OneOrMany, Public, UrlOr};

/// Crate [`Result`] alias with the default error type set to [`Error`].
pub type Result<T, E = Error> = core::result::Result<T, E>;