summaryrefslogtreecommitdiffstats
path: root/src/frontend/json.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/frontend/json.rs')
-rw-r--r--src/frontend/json.rs9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/frontend/json.rs b/src/frontend/json.rs
index cd7e651..b9d2007 100644
--- a/src/frontend/json.rs
+++ b/src/frontend/json.rs
@@ -15,6 +15,15 @@ use librepology::v1::api::Api;
pub struct JsonFrontend(Stdout);
+/// A Frontend that serializes the data to JSON
+///
+/// Useful for piping the data as structured data to another program.
+///
+/// # Warning
+///
+/// This frontend does _not_ maintain compatibility with repolocli itself. That means that piping
+/// output from repolocli to repolocli is _NOT_ supported by this frontend.
+///
impl JsonFrontend {
pub fn new(stdout: Stdout) -> Self {
JsonFrontend(stdout)