Struct PlatformEncoding

pub struct PlatformEncoding;

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

This differs from NativeEncoding 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::{PlatformEncoding, UnixEncoding, WindowsEncoding};

// The platform encoding is considered a distinct type from Unix/Windows encodings.
assert_ne!(TypeId::of::<PlatformEncoding>(), TypeId::of::<UnixEncoding>());
assert_ne!(TypeId::of::<PlatformEncoding>(), TypeId::of::<WindowsEncoding>());

Trait Implementations

impl Clone for PlatformEncoding

fn clone(&self) -> PlatformEncoding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlatformEncoding

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

Formats the value using the given formatter.

impl Display for PlatformEncoding

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

Formats the value using the given formatter.

impl Encoding for PlatformEncoding

type Components<'a> = <UnixEncoding as Encoding>::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: &[u8]) -> Self::Components<'_>

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

fn hash<H: Hasher>(path: &[u8], h: &mut H)

Hashes a byte slice (path)

fn push(current_path: &mut Vec<u8>, path: &[u8])

Pushes a byte slice (path) onto the an existing path (current_path)

fn push_checked( current_path: &mut Vec<u8>, path: &[u8], ) -> Result<(), CheckedPathError>

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

impl Copy for PlatformEncoding