Struct ZipString

pub struct ZipString { /* private fields */ }

A string wrapper for handling different encodings.

Implementations

impl ZipString

pub fn new(raw: Vec<u8>, encoding: StringEncoding) -> Self

Constructs a new encoded string from its raw bytes and its encoding type.

Note

If the provided encoding is StringEncoding::Utf8 but the raw bytes are not valid UTF-8 (ie. a call to std::str::from_utf8() fails), the encoding is defaulted back to StringEncoding::Raw.

pub fn new_with_alternative(utf8: String, alternative: Vec<u8>) -> Self

Constructs a new encoded string from utf-8 data, with an alternative in native MBCS encoding.

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

Returns the raw bytes for this string.

pub fn encoding(&self) -> StringEncoding

Returns the encoding type for this string.

pub fn alternative(&self) -> Option<&[u8]>

Returns the alternative bytes (in native MBCS encoding) for this string.

pub fn as_str(&self) -> Result<&str>

Returns the raw bytes converted into a string slice.

Note

A call to this method will only succeed if the encoding type is StringEncoding::Utf8.

pub fn into_string(self) -> Result<String>

Returns the raw bytes converted to an owned string.

Note

A call to this method will only succeed if the encoding type is StringEncoding::Utf8.

pub fn into_alternative(self) -> Option<Vec<u8>>

Returns the alternative bytes (in native MBCS encoding) converted to the owned.

pub fn is_utf8_without_alternative(&self) -> bool

Returns whether this string is encoded as utf-8 without an alternative.

Trait Implementations

impl Clone for ZipString

fn clone(&self) -> ZipString

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZipString

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

Formats the value using the given formatter.

impl From<&str> for ZipString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for ZipString

fn from(value: String) -> Self

Converts to this type from the input type.