aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-03-23 00:17:08 +0100
committerTeddy Wing2022-03-23 00:17:08 +0100
commit087856980808aa210d12a2cc8d0e047c5cdb2869 (patch)
tree94df42a9b0f221a6b75af44b69992fe3cd527f1b
parent0388e18a5338e646df2a073c310e0ba955dcfdcc (diff)
downloadyaqlite-087856980808aa210d12a2cc8d0e047c5cdb2869.tar.bz2
yaml::write: Add documentation
-rw-r--r--src/yaml/write.rs4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/yaml/write.rs b/src/yaml/write.rs
index b7970b4..4234a8c 100644
--- a/src/yaml/write.rs
+++ b/src/yaml/write.rs
@@ -1,10 +1,10 @@
-/// TODO
+/// Adapt a `std::io::Write` type into a `std::fmt::Write`.
pub struct IoAdapter<'a, T: std::io::Write> {
inner: &'a mut T,
}
impl<'a, T: std::io::Write> IoAdapter<'a, T> {
- /// TODO
+ /// Create a new `IoAdapter` that wraps the given `std::io::Write` type.
pub fn new(writer: &'a mut T) -> Self {
IoAdapter { inner: writer }
}