From 748ccabebb9f7e0e279d49567ea23395ae4183f1 Mon Sep 17 00:00:00 2001 From: yggverse Date: Fri, 1 Nov 2024 05:28:36 +0200 Subject: [PATCH] update comments --- src/client/response/meta/data.rs | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/src/client/response/meta/data.rs b/src/client/response/meta/data.rs index 737b21c..f0fd1cd 100644 --- a/src/client/response/meta/data.rs +++ b/src/client/response/meta/data.rs @@ -1,3 +1,6 @@ +//! Components for reading and parsing meta **data** bytes from response +//! (e.g. placeholder text for 10, 11, url string for 30, 31 etc) + pub mod error; pub use error::Error; @@ -5,19 +8,18 @@ use glib::GString; pub const MAX_LEN: usize = 0x400; // 1024 -/// Meta data holder for response +/// Meta **data** holder /// -/// Could be created from entire response buffer or just header slice -/// -/// Use as: -/// * placeholder for 10, 11 status -/// * URL for 30, 31 status +/// For example, `value` could contain: +/// * placeholder text for 10, 11 status +/// * URL string for 30, 31 status pub struct Data { value: GString, } impl Data { - /// Parse meta data from UTF-8 buffer + /// Parse meta **data** from UTF-8 buffer + /// from entire response or just header slice /// /// * result could be `None` for some [status codes](https://geminiprotocol.net/docs/protocol-specification.gmi#status-codes) /// that does not expect any data in header