Enum PlatformString 

pub enum PlatformString {
    Unix(Vec<u8>),
    WindowsUtf16Le(Vec<u8>),
}

Represents a platform-native string in an interoperable on-disk form.

This type is intended for forensic preservation of path-bearing values such as file names or symlink targets. In contrast to String, it does not require UTF-8 and preserves the original encoded bytes exactly.

Encoding variants:

• PlatformString::Unix: raw Unix pathname bytes
• PlatformString::WindowsUtf16Le: raw bytes interpreted as UTF-16 little-endian

The stored bytes are preserved exactly during encoding/decoding, even if they are malformed for the declared encoding. Validation is only performed by explicit conversion helpers such as PlatformString::to_string_strict.

Serde behavior

When the serde feature is enabled, PlatformString values that are serialized through higher-level structures may be emitted in a lossy, human-readable form. This is intentional:

• binary zff encoding/decoding remains lossless
• serde output is intended for display/export formats such as JSON or TOML
• serde serialization must not be relied upon for forensic preservation

In other words:

• ValueEncoder / ValueDecoder: exact byte-preserving representation
• serde::Serialize: human-readable representation, potentially lossy

Display behavior

Display uses a lossy conversion and is intended only for human-readable output, not for forensic round-tripping.

Variants

Unix(Vec<u8>)

Raw bytes interpreted as UTF-8

WindowsUtf16Le(Vec<u8>)

Raw bytes interpreted as UTF-16 little-endian.

Implementations

impl PlatformString

pub fn as_bytes(&self) -> &[u8]

Byte representation of the appropriate PlatformString. Does not contain the encoding information.

pub fn into_bytes(self) -> Vec<u8>

Byte representation of the appropriate PlatformString. Does not contain the encoding information.

pub fn to_string_strict(&self) -> Result<String>

Ensures that the Result is a UTF-8 valid string. Fails if the string does contain invalid UTF-8 characters.

pub fn to_string_lossy(&self) -> String

Lossy conversation to String. Note: This conversion is lossy and only intended only for human-readable output, not for forensic round-tripping.

Trait Implementations

impl Clone for PlatformString

fn clone(&self) -> PlatformString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlatformString

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

Formats the value using the given formatter.

impl Display for PlatformString

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

Formats the value using the given formatter.

impl Eq for PlatformString

impl From<&OsStr> for PlatformString

Available on target_family=unix only.

fn from(value: &OsStr) -> Self

Converts to this type from the input type.

impl From<OsString> for PlatformString

Available on target_family=unix only.

fn from(value: OsString) -> Self

Converts to this type from the input type.

impl Hash for PlatformString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PlatformString

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for PlatformString

fn eq(&self, other: &PlatformString) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for PlatformString

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for PlatformString

impl TryFrom<&PlatformString> for OsString

Available on target_family=unix only.

type Error = ZffError

The type returned in the event of a conversion error.

fn try_from(value: &PlatformString) -> Result<Self>

Performs the conversion.

impl ValueDecoder for PlatformString

type Item = PlatformString

the return value for decode_directly() and decode_for_key();

fn decode_directly<R: Read>(data: &mut R) -> Result<Self::Item>

decodes the value directly.

fn check_key_on_position<K: Into<String>, R: Read>(data: &mut R, key: K) -> bool

helper method to check, if the key is on position.

fn decode_for_key<K: Into<String>, R: Read>( data: &mut R, key: K, ) -> Result<Self::Item>

decodes the value for the given key.

fn decode_at<R: ReadAt + ?Sized>(data: &R, offset: u64) -> Result<Self::Item>

Decodes the value at given offset from ReadAt.

impl ValueEncoder for PlatformString

fn encode_directly(&self) -> Vec<u8>

encodes the value directly (= without key).

fn identifier(&self) -> u8

returns the identifier of the appropriate type.

fn encoded_size(&self) -> usize

Returns the size of an encoded element.

fn encode_for_key(&self, key: &str) -> Vec<u8>

encodes a key to the value.

fn encode_with_identifier(&self) -> Vec<u8>

encodes with the appropriate type identifier.