io, serde, schema: doc fixups

Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2024-07-30 16:16:16 +02:00
parent ffd45c642f
commit 65715bc096
3 changed files with 4 additions and 3 deletions

View File

@ -4,7 +4,8 @@ use std::sync::mpsc::SyncSender;
/// Wrapper around SyncSender, which implements Write /// Wrapper around SyncSender, which implements Write
/// ///
/// Each write in translated into a send(Vec<u8>). /// Each write in translated into a `send(Vec<u8>)` (that is, for each write, an owned byte vector
/// is allocated and sent over the channel).
pub struct StdChannelWriter<E>(SyncSender<Result<Vec<u8>, E>>); pub struct StdChannelWriter<E>(SyncSender<Result<Vec<u8>, E>>);
impl<E: ToString> StdChannelWriter<E> { impl<E: ToString> StdChannelWriter<E> {

View File

@ -99,7 +99,7 @@ fn push_err_do(path: String, err: anyhow::Error) {
/// Helper to collect multiple deserialization errors for better reporting. /// Helper to collect multiple deserialization errors for better reporting.
/// ///
/// This is similar to [`IgnoredAny`] in that it implements [`Deserialize`] /// This is similar to [`IgnoredAny`](serde::de::IgnoredAny) in that it implements [`Deserialize`]
/// but does not actually deserialize to anything, however, when a deserialization error occurs, /// but does not actually deserialize to anything, however, when a deserialization error occurs,
/// it'll try to continue and collect further errors. /// it'll try to continue and collect further errors.
/// ///

View File

@ -180,7 +180,7 @@ pub mod string_as_base64 {
} }
} }
/// Serialize Vec<u8> as base64url encoded string without padding. /// Serialize `Vec<u8>` as base64url encoded string without padding.
/// ///
/// Usage example: /// Usage example:
/// ``` /// ```