Struct Utf8PlatformEncoding

pub struct Utf8PlatformEncoding;

Represents an abstraction of Utf8Encoding that represents the current platform encoding.

This differs from Utf8NativeEncoding in that it is its own struct instead of a type alias to the platform-specific encoding, and can therefore be used to enforce more strict compile-time checks of encodings without needing to leverage conditional configs.

Examples

use core::any::TypeId;
use typed_path::{Utf8PlatformEncoding, Utf8UnixEncoding, Utf8WindowsEncoding};

// The UTF8 platform encoding is considered a distinct type from UTF8 Unix/Windows encodings.
assert_ne!(TypeId::of::<Utf8PlatformEncoding>(), TypeId::of::<Utf8UnixEncoding>());
assert_ne!(TypeId::of::<Utf8PlatformEncoding>(), TypeId::of::<Utf8WindowsEncoding>());

Trait Implementations

impl Clone for Utf8PlatformEncoding

fn clone(&self) -> Utf8PlatformEncoding

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Utf8PlatformEncoding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Utf8PlatformEncoding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Utf8Encoding for Utf8PlatformEncoding

type Components<'a> = <Utf8UnixEncoding as Utf8Encoding>::Components<'a>

Represents the type of component that will be derived by this encoding

fn label() -> &'static str

Static label representing encoding type

fn components(path: &str) -> Self::Components<'_>

Produces an iterator of Utf8Components over the given the byte slice (path)

fn hash<H: Hasher>(path: &str, h: &mut H)

Hashes a utf8 str (path)

fn push(current_path: &mut String, path: &str)

Pushes a utf8 str (path) onto the an existing path (current_path)

fn push_checked( current_path: &mut String, path: &str, ) -> Result<(), CheckedPathError>

Like Utf8Encoding::push, but enforces several new rules:

impl Copy for Utf8PlatformEncoding