instant-labs
/
instant-epp
mirror of https://github.com/instant-labs/instant-epp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docs at some places

This commit is contained in:
Rudi Floren 2023-01-17 15:51:07 +01:00
parent 4922c4e370
commit 99019d9110
No known key found for this signature in database
GPG Key ID: 3667D82FA1AA6CEB
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/client.rs
View File

@ -16,7 +16,9 @@ use crate::request::{Command, CommandDocument, Extension, Transaction};
use crate::response::{Response, ResponseDocument, ResponseStatus}; use crate::response::{Response, ResponseDocument, ResponseStatus};
use crate::xml; 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. /// 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 /// 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 { impl EppClient {
/// Create an `EppClient` from an already established connection
pub(crate) fn new(sender: mpsc::UnboundedSender<Request>, registry: Cow<'static, str>) -> Self { pub(crate) fn new(sender: mpsc::UnboundedSender<Request>, registry: Cow<'static, str>) -> Self {
Self { Self {
inner: Arc::new(InnerClient { sender, registry }), inner: Arc::new(InnerClient { sender, registry }),
@ -91,6 +92,9 @@ impl EppClient {
Ok(xml::deserialize::<GreetingDocument>(&response)?.data) Ok(xml::deserialize::<GreetingDocument>(&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>( pub async fn transact<'c, 'e, Cmd, Ext>(
&mut self, &mut self,
data: impl Into<RequestData<'c, 'e, Cmd, Ext>>, data: impl Into<RequestData<'c, 'e, Cmd, Ext>>,