aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2022-03-21 02:21:59 +0100
committerTeddy Wing2022-03-21 02:21:59 +0100
commit28fb8fd2df135d3234b1230acbf98a0a08b14110 (patch)
treec497784150319a6a8fac280048faec452f007531
parent5fc732507522af3565655b01f1473baa0e1a1da2 (diff)
downloadyaqlite-28fb8fd2df135d3234b1230acbf98a0a08b14110.tar.bz2
sql: Add documentation
-rw-r--r--src/yaml/sql.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/yaml/sql.rs b/src/yaml/sql.rs
index a9644eb..61c9d6c 100644
--- a/src/yaml/sql.rs
+++ b/src/yaml/sql.rs
@@ -3,12 +3,13 @@ use yaml_rust::yaml;
use std::borrow::Cow;
-/// TODO
+/// Wrap `yaml_rust::Yaml`, adding implementations for `rusqlite::ToSql` and
+/// `rusqlite::types::FromSql`.
#[derive(Debug)]
pub(crate) struct Yaml<'a>(pub Cow<'a, yaml::Yaml>);
impl<'a> Yaml<'a> {
- /// TODO
+ /// Extracts the wrapped `yaml_rust::Yaml`.
pub fn into_inner(self) -> yaml::Yaml {
self.0.into_owned()
}