updated mod level doc

Signed-off-by: minghuaw <michael.wu1107@gmail.com>
This commit is contained in:
minghuaw 2022-08-18 10:55:11 -07:00
parent c26131f8cb
commit c477db4305
3 changed files with 41 additions and 43 deletions

View File

@ -1,5 +1,5 @@
//! This module integrated the [cloudevents-sdk](https://docs.rs/cloudevents-sdk) with
//! [fe2o3-amqp](https://docs.rs/fe2o3-amqp/) to easily send and receiver CloudEvents
//! [fe2o3-amqp](https://docs.rs/fe2o3-amqp/) to easily send and receive CloudEvents
//!
//! To send CloudEvents
//!
@ -12,30 +12,30 @@
//!
//! #[tokio::main]
//! async fn main() {
//! let mut connection =
//! Connection::open("cloudevents-sdk-rust", "amqp://guest:guest@localhost:5672")
//! .await
//! .unwrap();
//! let mut session = Session::begin(&mut connection).await.unwrap();
//! let mut sender = Sender::attach(&mut session, "sender", "q1").await.unwrap();
//!
//! let event = EventBuilderV10::new()
//! .id(i.to_string())
//! .ty("example.test")
//! .source("localhost")
//! .extension("ext-name", "AMQP")
//! .data("application/json", value)
//! .build()
//! .unwrap();
//!
//! let event_message = EventMessage::from_binary_event(event).unwrap();
//! let message = AmqpMessage::from(event_message);
//! sender.send(message).await.unwrap()
//! .accepted_or("not accepted").unwrap();
//!
//! sender.close().await.unwrap();
//! session.end().await.unwrap();
//! connection.close().await.unwrap();
//! let mut connection =
//! Connection::open("cloudevents-sdk-rust", "amqp://guest:guest@localhost:5672")
//! .await
//! .unwrap();
//! let mut session = Session::begin(&mut connection).await.unwrap();
//! let mut sender = Sender::attach(&mut session, "sender", "q1").await.unwrap();
//!
//! let event = EventBuilderV10::new()
//! .id(i.to_string())
//! .ty("example.test")
//! .source("localhost")
//! .extension("ext-name", "AMQP")
//! .data("application/json", value)
//! .build()
//! .unwrap();
//!
//! let event_message = EventMessage::from_binary_event(event).unwrap();
//! let message = AmqpMessage::from(event_message);
//! sender.send(message).await.unwrap()
//! .accepted_or("not accepted").unwrap();
//!
//! sender.close().await.unwrap();
//! session.end().await.unwrap();
//! connection.close().await.unwrap();
//! }
//! ```
//!
@ -50,22 +50,22 @@
//!
//! #[tokio::main]
//! async fn main() {
//! let mut connection =
//! Connection::open("cloudevents-sdk-rust", "amqp://guest:guest@localhost:5672")
//! .await
//! .unwrap();
//! let mut session = Session::begin(&mut connection).await.unwrap();
//! let mut receiver = Receiver::attach(&mut session, "receiver", "q1").await.unwrap();
//!
//! let delivery = receiver.recv().await.unwrap();
//! receiver.accept(&delivery).await.unwrap();
//!
//! let event_message = EventMessage::from(delivery.into_message());
//! let event = MessageDeserializer::into_event(event_message).unwrap();
//!
//! sender.close().await.unwrap();
//! session.end().await.unwrap();
//! connection.close().await.unwrap();
//! let mut connection =
//! Connection::open("cloudevents-sdk-rust", "amqp://guest:guest@localhost:5672")
//! .await
//! .unwrap();
//! let mut session = Session::begin(&mut connection).await.unwrap();
//! let mut receiver = Receiver::attach(&mut session, "receiver", "q1").await.unwrap();
//!
//! let delivery = receiver.recv().await.unwrap();
//! receiver.accept(&delivery).await.unwrap();
//!
//! let event_message = EventMessage::from(delivery.into_message());
//! let event = MessageDeserializer::into_event(event_message).unwrap();
//!
//! sender.close().await.unwrap();
//! session.end().await.unwrap();
//! connection.close().await.unwrap();
//! }
//! ```

View File

@ -4,7 +4,6 @@
pub mod actix;
#[cfg(feature = "axum")]
pub mod axum;
#[cfg_attr(docrs, doc(cfg(feature = "fe2o3-amqp")))]
#[cfg(feature = "fe2o3-amqp")]
pub mod fe2o3_amqp;
#[cfg(any(

View File

@ -56,7 +56,6 @@
#![doc(html_root_url = "https://docs.rs/cloudevents-sdk/0.5.0")]
#![deny(rustdoc::broken_intra_doc_links)]
#![cfg_attr(docsrs, feature(doc_cfg))] // Show feature gate in doc
pub mod binding;
pub mod event;