Fixed docs
Verified `cargo doc --all-features` works Signed-off-by: Jim Crossley <jim@crossleys.org>
This commit is contained in:
parent
538b647804
commit
69f16a5144
|
@ -1,4 +1,4 @@
|
||||||
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Actix web](https://docs.rs/actix-web/) to easily send and receive CloudEvents.
|
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Actix web](https://docs.rs/actix-web/) to easily send and receive CloudEvents.
|
||||||
//!
|
//!
|
||||||
//! To deserialize an HTTP request as CloudEvent:
|
//! To deserialize an HTTP request as CloudEvent:
|
||||||
//!
|
//!
|
||||||
|
@ -38,10 +38,7 @@
|
||||||
//! )
|
//! )
|
||||||
//! }
|
//! }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
|
||||||
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
|
|
||||||
|
|
||||||
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
|
|
||||||
#![deny(broken_intra_doc_links)]
|
#![deny(broken_intra_doc_links)]
|
||||||
|
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
|
|
|
@ -29,15 +29,9 @@
|
||||||
//! * The [`EventBuilder`] trait and implementations, to create [`Event`] instances
|
//! * The [`EventBuilder`] trait and implementations, to create [`Event`] instances
|
||||||
//! * The implementation of [`serde::Serialize`] and [`serde::Deserialize`] for [`Event`] to serialize/deserialize CloudEvents to/from JSON
|
//! * The implementation of [`serde::Serialize`] and [`serde::Deserialize`] for [`Event`] to serialize/deserialize CloudEvents to/from JSON
|
||||||
//! * Traits and utilities in [`message`] to implement Protocol Bindings
|
//! * Traits and utilities in [`message`] to implement Protocol Bindings
|
||||||
//!
|
//! * Feature-guarded modules for various Protocol Binding implementations, e.g. actix, reqwest, warp, rdkafka
|
||||||
//! If you're looking for Protocol Binding implementations, look at crates:
|
|
||||||
//!
|
|
||||||
//! * [cloudevents-sdk-actix-web](https://docs.rs/cloudevents-sdk-actix-web): Integration with [Actix Web](https://github.com/actix/actix-web)
|
|
||||||
//! * [cloudevents-sdk-reqwest](https://docs.rs/cloudevents-sdk-reqwest): Integration with [reqwest](https://github.com/seanmonstar/reqwest)
|
|
||||||
//! * [cloudevents-sdk-rdkafka](https://docs.rs/cloudevents-sdk-rdkafka): Integration with [rdkafka](https://fede1024.github.io/rust-rdkafka)
|
|
||||||
//!
|
//!
|
||||||
|
|
||||||
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
|
|
||||||
#![deny(broken_intra_doc_links)]
|
#![deny(broken_intra_doc_links)]
|
||||||
|
|
||||||
#[cfg(feature = "cloudevents-actix")]
|
#[cfg(feature = "cloudevents-actix")]
|
||||||
|
|
|
@ -11,7 +11,7 @@ use rdkafka::producer::{BaseRecord, FutureRecord};
|
||||||
/// Implements [`StructuredSerializer`] & [`BinarySerializer`] traits.
|
/// Implements [`StructuredSerializer`] & [`BinarySerializer`] traits.
|
||||||
///
|
///
|
||||||
/// To instantiate a new `MessageRecord` from an [`Event`],
|
/// To instantiate a new `MessageRecord` from an [`Event`],
|
||||||
/// look at [`Self::from_event`] or use [`StructuredDeserializer::deserialize_structured`](cloudevents::message::StructuredDeserializer::deserialize_structured)
|
/// look at [`Self::from_event`] or use [`StructuredDeserializer::deserialize_structured`](crate::message::StructuredDeserializer::deserialize_structured)
|
||||||
/// or [`BinaryDeserializer::deserialize_binary`].
|
/// or [`BinaryDeserializer::deserialize_binary`].
|
||||||
pub struct MessageRecord {
|
pub struct MessageRecord {
|
||||||
pub(crate) headers: OwnedHeaders,
|
pub(crate) headers: OwnedHeaders,
|
||||||
|
|
|
@ -48,7 +48,6 @@
|
||||||
//! # }
|
//! # }
|
||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
|
|
||||||
#![deny(broken_intra_doc_links)]
|
#![deny(broken_intra_doc_links)]
|
||||||
|
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [reqwest](https://docs.rs/reqwest/) to easily send and receive CloudEvents.
|
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [reqwest](https://docs.rs/reqwest/) to easily send and receive CloudEvents.
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! use cloudevents::reqwest::{RequestBuilderExt, ResponseExt};
|
//! use cloudevents::reqwest::{RequestBuilderExt, ResponseExt};
|
||||||
|
@ -26,10 +26,7 @@
|
||||||
//! # Ok(())
|
//! # Ok(())
|
||||||
//! # }
|
//! # }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
|
||||||
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`].
|
|
||||||
|
|
||||||
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.3.1")]
|
|
||||||
#![deny(broken_intra_doc_links)]
|
#![deny(broken_intra_doc_links)]
|
||||||
|
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
|
|
|
@ -13,7 +13,7 @@ pub struct EventFilterError {
|
||||||
impl warp::reject::Reject for EventFilterError {}
|
impl warp::reject::Reject for EventFilterError {}
|
||||||
|
|
||||||
///
|
///
|
||||||
/// # Extracts [`cloudevents::Event`] from incoming request
|
/// # Extracts [`crate::Event`] from incoming request
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use cloudevents::warp::filter::to_event;
|
/// use cloudevents::warp::filter::to_event;
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
//! This crate integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Warp web service framework](https://docs.rs/warp/)
|
//! This module integrates the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with [Warp web service framework](https://docs.rs/warp/)
|
||||||
//! to easily send and receive CloudEvents.
|
//! to easily send and receive CloudEvents.
|
||||||
//!
|
//!
|
||||||
//! To deserialize an HTTP request as CloudEvent
|
//! To deserialize an HTTP request as CloudEvent
|
||||||
|
@ -57,8 +57,6 @@
|
||||||
//! });
|
//! });
|
||||||
//! warp::serve(routes).run(([127, 0, 0, 1], 3030));
|
//! warp::serve(routes).run(([127, 0, 0, 1], 3030));
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
|
||||||
//! Check out the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) docs for more details on how to use [`cloudevents::Event`]
|
|
||||||
|
|
||||||
#[macro_use]
|
#[macro_use]
|
||||||
mod headers;
|
mod headers;
|
||||||
|
|
|
@ -5,7 +5,7 @@ use http::StatusCode;
|
||||||
use warp::reply::Response;
|
use warp::reply::Response;
|
||||||
|
|
||||||
///
|
///
|
||||||
/// # Serializes [`cloudevents::Event`] as a http response
|
/// # Serializes [`crate::Event`] as a http response
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use cloudevents::warp::reply::from_event;
|
/// use cloudevents::warp::reply::from_event;
|
||||||
|
|
Loading…
Reference in New Issue