mosaik 0.3.17

A Rust runtime for building self-organizing, leaderless distributed systems.
Documentation
//! Formatting utilities for primitives.

#![allow(unused)]

use {
	core::fmt,
	derive_more::{AsRef, Deref},
};

/// Trait for wrapper types that format a value.
trait FmtWrapper<T> {
	fn wrap(value: T) -> Self;
}

/// A wrapper type that pretty-prints the inner value.
#[derive(Deref, AsRef)]
pub struct Pretty<'a, T: ?Sized>(pub &'a T);

impl<T> Pretty<'_, T> {
	pub const fn iter<I: IntoIterator<Item = T>>(iter: I) -> FmtIter<Self, I> {
		FmtIter::new(iter)
	}
}

pub trait PrettyFmtExt<'a> {
	fn pretty(&'a self) -> Pretty<'a, Self>;
}

impl<'a, T: 'a> PrettyFmtExt<'a> for T
where
	Pretty<'a, T>: core::fmt::Display,
{
	fn pretty(&'a self) -> Pretty<'a, Self> {
		Pretty(self)
	}
}

/// A wrapper type that formats the inner value as a shortened hex string.
pub struct Short<T>(pub T);
impl<T: AsRef<[u8]>> fmt::Display for Short<T> {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		const LEN: usize = 5;
		let s = self.0.as_ref();
		if s.len() <= LEN {
			write!(f, "{}", hex::encode(s))
		} else {
			write!(f, "{}", hex::encode(&s[0..LEN]),)
		}
	}
}

impl<T: AsRef<[u8]>> fmt::Debug for Short<T> {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		<Self as fmt::Display>::fmt(self, f)
	}
}

impl<T> FmtWrapper<T> for Short<T> {
	fn wrap(value: T) -> Self {
		Self(value)
	}
}

impl<T> Short<T> {
	pub const fn iter<I: IntoIterator<Item = T>>(iter: I) -> FmtIter<Self, I> {
		FmtIter::new(iter)
	}
}

pub trait ShortFmtExt {
	fn short(&self) -> Short<&Self>;
}

impl<T> ShortFmtExt for T
where
	Short<T>: core::fmt::Display,
{
	fn short(&self) -> Short<&Self> {
		Short(self)
	}
}

/// A wrapper type that formats the inner string as an abbreviated hex string
pub struct Abbreviated<const LEN: usize, T>(pub T);
impl<const LEN: usize, T: AsRef<[u8]>> fmt::Display for Abbreviated<LEN, T> {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		let s = self.0.as_ref();
		if s.len() <= LEN {
			write!(f, "{}", &hex::encode(s))
		} else {
			let half = LEN / 2;
			write!(
				f,
				"{}..{}",
				&hex::encode(&s[0..half]),
				&hex::encode(&s[s.len() - half..])
			)
		}
	}
}

impl<const LEN: usize, T: AsRef<[u8]>> fmt::Debug for Abbreviated<LEN, T> {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		<Self as fmt::Display>::fmt(self, f)
	}
}

impl<T, const LEN: usize> FmtWrapper<T> for Abbreviated<LEN, T> {
	fn wrap(value: T) -> Self {
		Self(value)
	}
}

/// A wrapper type that redacts the inner value when formatted.
pub struct Redacted<T>(pub T);
impl<T> fmt::Display for Redacted<T> {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		write!(f, "<redacted>")
	}
}

impl<T> fmt::Debug for Redacted<T> {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		<Self as fmt::Display>::fmt(self, f)
	}
}

impl<T> FmtWrapper<T> for Redacted<T> {
	fn wrap(value: T) -> Self {
		Self(value)
	}
}

pub trait RedactedFmtExt {
	fn redacted(&self) -> Redacted<&Self>;
}

impl<T> RedactedFmtExt for T
where
	Redacted<T>: core::fmt::Display,
{
	fn redacted(&self) -> Redacted<&Self> {
		Redacted(self)
	}
}

/// A wrapper type that formats an iterator of items using a specified wrapper.
///
/// # Example
/// ```ignore
/// let hashes: Vec<[u8; 32]> = vec![...];
/// println!("{}", FmtIter::<_, Short<_>>(&hashes));
/// println!("{}", FmtIter::<_, Abbreviated<_>>(&hashes));
/// ```
pub struct FmtIter<W, I>(pub I, core::marker::PhantomData<W>);

impl<I, W> FmtIter<W, I> {
	pub const fn new(iter: I) -> Self {
		Self(iter, core::marker::PhantomData)
	}
}

impl<I, T, W> fmt::Display for FmtIter<W, I>
where
	I: IntoIterator<Item = T> + Clone,
	W: FmtWrapper<T> + fmt::Display,
{
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		write!(f, "[")?;
		for (i, item) in self.0.clone().into_iter().enumerate() {
			if i > 0 {
				write!(f, ", ")?;
			}
			write!(f, "{}", W::wrap(item))?;
		}
		write!(f, "]")
	}
}