From 99019d9110bb03b7b4049e937f56feffa12596bb Mon Sep 17 00:00:00 2001 From: Rudi Floren Date: Tue, 17 Jan 2023 15:51:07 +0100 Subject: [PATCH] Improve docs at some places --- src/client.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/client.rs b/src/client.rs index f7b3948..0b2d5bc 100644 --- a/src/client.rs +++ b/src/client.rs @@ -16,7 +16,9 @@ use crate::request::{Command, CommandDocument, Extension, Transaction}; use crate::response::{Response, ResponseDocument, ResponseStatus}; use crate::xml; -/// An `EppClient` provides an interface to sending EPP requests to a registry +/// EPP Client +/// +/// Provides an interface to send EPP requests to a registry /// /// Once initialized, the [`EppClient`] instance is the API half that is returned when creating a new connection. /// It can serialize EPP requests to XML and send them to the registry and deserialize the XML responses from the @@ -70,7 +72,6 @@ pub struct EppClient { } impl EppClient { - /// Create an `EppClient` from an already established connection pub(crate) fn new(sender: mpsc::UnboundedSender, registry: Cow<'static, str>) -> Self { Self { inner: Arc::new(InnerClient { sender, registry }), @@ -91,6 +92,9 @@ impl EppClient { Ok(xml::deserialize::(&response)?.data) } + /// Sends a EPP request and await its response + /// + /// The given transactions id is not checked internally when build in release mode. pub async fn transact<'c, 'e, Cmd, Ext>( &mut self, data: impl Into>,