make final codes public, add comments

This commit is contained in:
yggverse 2025-03-24 23:32:18 +02:00
parent 4eb998ef20
commit 473ed48715
6 changed files with 20 additions and 11 deletions

View file

@ -1,9 +1,10 @@
pub mod error; pub mod error;
pub use error::Error; pub use error::Error;
const CODE: &[u8] = b"61"; /// [Not Authorized](https://geminiprotocol.net/docs/protocol-specification.gmi#status-61) status code
pub const CODE: &[u8] = b"61";
/// Hold header `String` for [61](https://geminiprotocol.net/docs/protocol-specification.gmi#status-61) status code /// Hold header `String` for [Not Authorized](https://geminiprotocol.net/docs/protocol-specification.gmi#status-61) status code
/// * this response type does not contain body data /// * this response type does not contain body data
/// * the header member is closed to require valid construction /// * the header member is closed to require valid construction
pub struct NotAuthorized(String); pub struct NotAuthorized(String);

View file

@ -1,9 +1,10 @@
pub mod error; pub mod error;
pub use error::Error; pub use error::Error;
const CODE: &[u8] = b"62"; /// [Not Valid](https://geminiprotocol.net/docs/protocol-specification.gmi#status-62) status code
pub const CODE: &[u8] = b"62";
/// Hold header `String` for [62](https://geminiprotocol.net/docs/protocol-specification.gmi#status-62) status code /// Hold header `String` for [Not Valid](https://geminiprotocol.net/docs/protocol-specification.gmi#status-62) status code
/// * this response type does not contain body data /// * this response type does not contain body data
/// * the header member is closed to require valid construction /// * the header member is closed to require valid construction
pub struct NotValid(String); pub struct NotValid(String);

View file

@ -1,9 +1,10 @@
pub mod error; pub mod error;
pub use error::Error; pub use error::Error;
const CODE: &[u8] = b"60"; /// [Certificate Required](https://geminiprotocol.net/docs/protocol-specification.gmi#status-60) status code
pub const CODE: &[u8] = b"60";
/// Hold header `String` for [60](https://geminiprotocol.net/docs/protocol-specification.gmi#status-60) status code /// Hold header `String` for [Certificate Required](https://geminiprotocol.net/docs/protocol-specification.gmi#status-60) status code
/// * this response type does not contain body data /// * this response type does not contain body data
/// * the header member is closed to require valid construction /// * the header member is closed to require valid construction
pub struct Required(String); pub struct Required(String);

View file

@ -1,9 +1,10 @@
pub mod error; pub mod error;
pub use error::Error; pub use error::Error;
const CODE: &[u8] = b"10"; /// [Input Expected](https://geminiprotocol.net/docs/protocol-specification.gmi#status-10) status code
pub const CODE: &[u8] = b"10";
/// Hold header `String` for [10](https://geminiprotocol.net/docs/protocol-specification.gmi#status-10) status code /// Hold header `String` for [Input Expected](https://geminiprotocol.net/docs/protocol-specification.gmi#status-10) status code
/// * this response type does not contain body data /// * this response type does not contain body data
/// * the header member is closed to require valid construction /// * the header member is closed to require valid construction
pub struct Default(String); pub struct Default(String);

View file

@ -1,9 +1,10 @@
pub mod error; pub mod error;
pub use error::Error; pub use error::Error;
const CODE: &[u8] = b"11"; /// [Sensitive Input](https://geminiprotocol.net/docs/protocol-specification.gmi#status-11-sensitive-input) status code
pub const CODE: &[u8] = b"11";
/// Hold header `String` for [11](https://geminiprotocol.net/docs/protocol-specification.gmi#status-11-sensitive-input) status code /// Hold header `String` for [Sensitive Input](https://geminiprotocol.net/docs/protocol-specification.gmi#status-11-sensitive-input) status code
/// * this response type does not contain body data /// * this response type does not contain body data
/// * the header member is closed to require valid construction /// * the header member is closed to require valid construction
pub struct Sensitive(String); pub struct Sensitive(String);

View file

@ -4,8 +4,12 @@ pub mod header;
pub use error::Error; pub use error::Error;
pub use header::Header; pub use header::Header;
const CODE: &[u8] = b"20"; /// [Success](https://geminiprotocol.net/docs/protocol-specification.gmi#success) status code
pub const CODE: &[u8] = b"20";
/// Holder for [Success](https://geminiprotocol.net/docs/protocol-specification.gmi#success) status code
/// * this response type MAY contain body data
/// * the header has closed members to require valid construction
pub struct Default { pub struct Default {
pub header: Header, pub header: Header,
pub content: Option<Vec<u8>>, pub content: Option<Vec<u8>>,