summaryrefslogtreecommitdiffstats
path: root/ipc
diff options
context:
space:
mode:
authorNora Widdecke <nora@sequoia-pgp.org>2021-08-23 16:55:26 +0200
committerNora Widdecke <nora@sequoia-pgp.org>2021-08-27 12:58:07 +0200
commite5746684e84377dd8828f6a5a8ab4c0eec73c3ec (patch)
tree5261ba9f497ec5ce51d47198742919673de3c893 /ipc
parent078c4d7ee16ea06977ec8cb7cf5571c880e9c710 (diff)
Convert markdown to intra-doc links.
- Apply cargo intraconv.
Diffstat (limited to 'ipc')
-rw-r--r--ipc/src/assuan/mod.rs25
-rw-r--r--ipc/src/lib.rs4
2 files changed, 13 insertions, 16 deletions
diff --git a/ipc/src/assuan/mod.rs b/ipc/src/assuan/mod.rs
index a1337ed4..9f7ab824 100644
--- a/ipc/src/assuan/mod.rs
+++ b/ipc/src/assuan/mod.rs
@@ -41,16 +41,13 @@ lalrpop_util::lalrpop_mod!(
/// command is sent lazily, i.e. it is only sent if you poll for the
/// responses.
///
-/// [`Connection::send`]: #method.send
+/// [`Connection::send`]: Client::send()
///
/// `Client` implements [`Stream`] to return all server responses
/// until the first [`Response::Ok`], [`Response::Error`], or
/// [`Response::Inquire`].
///
/// [`Stream`]: #impl-Stream
-/// [`Response::Ok`]: enum.Response.html#variant.Ok
-/// [`Response::Error`]: enum.Response.html#variant.Error
-/// [`Response::Inquire`]: enum.Response.html#variant.Inquire
///
/// [`Response::Ok`] and [`Response::Error`] indicate success and
/// failure. [`Response::Inquire`] means that the server requires
@@ -58,8 +55,8 @@ lalrpop_util::lalrpop_mod!(
/// provided using [`Connection::data()`], or the operation may be
/// canceled using [`Connection::cancel()`].
///
-/// [`Connection::data()`]: #method.data
-/// [`Connection::cancel()`]: #method.cancel
+/// [`Connection::data()`]: Client::data()
+/// [`Connection::cancel()`]: Client::cancel()
pub struct Client {
r: BufReader<ReadHalf<IpcStream>>, // xxx: abstract over
buffer: Vec<u8>,
@@ -99,11 +96,11 @@ impl Client {
/// [`Connection::data()`], or the operation may be canceled using
/// [`Connection::cancel()`].
///
- /// [`Response::Ok`]: ../assuan/enum.Response.html#variant.Ok
- /// [`Response::Error`]: ../assuan/enum.Response.html#variant.Error
- /// [`Response::Inquire`]: ../assuan/enum.Response.html#variant.Inquire
- /// [`Connection::data()`]: #method.data
- /// [`Connection::cancel()`]: #method.cancel
+ /// [`Response::Ok`]: super::assuan::Response::Ok
+ /// [`Response::Error`]: super::assuan::Response::Error
+ /// [`Response::Inquire`]: super::assuan::Response::Inquire
+ /// [`Connection::data()`]: Client::data()
+ /// [`Connection::cancel()`]: Client::cancel()
///
/// Note: `command` is passed as-is. Control characters, like
/// `%`, must be %-escaped.
@@ -157,9 +154,9 @@ impl Client {
/// and `Error` indicate success and failure of the original
/// operation that lead to the current inquiry.
///
- /// [`Response::Ok`]: ../assuan/enum.Response.html#variant.Ok
- /// [`Response::Error`]: ../assuan/enum.Response.html#variant.Error
- /// [`Response::Inquire`]: ../assuan/enum.Response.html#variant.Inquire
+ /// [`Response::Ok`]: super::assuan::Response::Ok
+ /// [`Response::Error`]: super::assuan::Response::Error
+ /// [`Response::Inquire`]: super::assuan::Response::Inquire
pub fn data<'a, C: 'a>(&'a mut self, data: C) -> Result<()>
where C: AsRef<[u8]>
{
diff --git a/ipc/src/lib.rs b/ipc/src/lib.rs
index 7c1f7e90..23f1fe1b 100644
--- a/ipc/src/lib.rs
+++ b/ipc/src/lib.rs
@@ -137,7 +137,7 @@ impl Descriptor {
/// This will panic if called outside of the Tokio runtime context. See
/// See [`Handle::enter`] for more details.
///
- /// [`Handle::enter`]: https://docs.rs/tokio/0.2.22/tokio/runtime/struct.Handle.html#method.enter
+ /// [`Handle::enter`]: tokio::runtime::Handle::enter()
pub fn connect(&self) -> Result<RpcSystem<Side>> {
self.connect_with_policy(*self.ctx.ipc_policy())
}
@@ -151,7 +151,7 @@ impl Descriptor {
/// This will panic if called outside of the Tokio runtime context. See
/// See [`Handle::enter`] for more details.
///
- /// [`Handle::enter`]: https://docs.rs/tokio/0.2.22/tokio/runtime/struct.Handle.html#method.enter
+ /// [`Handle::enter`]: tokio::runtime::Handle::enter()
pub fn connect_with_policy(&self, policy: core::IPCPolicy)
-> Result<RpcSystem<Side>> {
let do_connect = |cookie: Cookie, mut s: TcpStream| {