Trait print_bytes::ToBytes

pub trait ToBytes {
    fn to_bytes(&self) -> ByteStr<'_>;
    fn to_wide(&self) -> Option<WideStr>;
}

Represents a type similarly to Display.

Implement this trait to allow printing a type that cannot guarantee UTF-8 output. It is used to bound values accepted by functions in this crate.

Examples

use print_bytes::println_bytes;
use print_bytes::ByteStr;
use print_bytes::ToBytes;
#[cfg(windows)]
use print_bytes::WideStr;

struct ByteSlice<'a>(&'a [u8]);

impl ToBytes for ByteSlice<'_> {
    fn to_bytes(&self) -> ByteStr<'_> {
        self.0.to_bytes()
    }

    #[cfg(windows)]
    fn to_wide(&self) -> Option<WideStr> {
        self.0.to_wide()
    }
}

println_bytes(&ByteSlice(b"Hello, world!"));

Required methods

fn to_bytes(&self) -> ByteStr<'_>

Returns a byte string that will be used to represent the instance.

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

Returns a wide character string that will be used to represent the instance.

The Windows API frequently uses wide character strings. This method allows them to be printed losslessly in some cases, even when they cannot be converted to UTF-8.

Returning None causes to_bytes to be used instead.

Implementations on Foreign Types

impl ToBytes for [u8]

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl<const N: usize> ToBytes for [u8; N]

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl<T> ToBytes for Cow<'_, T> where
    T: ?Sized + ToBytes + ToOwned,
    T::Owned: ToBytes, 

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for CStr

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for CString

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for Vec<u8>

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for OsStr

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for OsString

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for Path

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

impl ToBytes for PathBuf

fn to_bytes(&self) -> ByteStr<'_>

fn to_wide(&self) -> Option<WideStr>

This is supported on Windows only.

Implementors