Enum InputString

pub(crate) enum InputString {
    Utf8(String),
    UncheckedBytes {
        bytes: Vec<u8>,
        validated: RefCell<bool>,
    },
    MappedBytes {
        bytes: Mmap,
        validated: RefCell<bool>,
    },
}

An abstraction over a possible string that we’ve loaded or mapped from a cache.

Variants

Utf8(String)

A string that’s been validated as UTF-8

UncheckedBytes

A set of unvalidated bytes.

Fields

bytes: Vec<u8>

The underlying bytes

validated: RefCell<bool>

Whether the bytes have been validated previously as UTF-8

MappedBytes

Available on crate feature mmap only.

A set of memory-mapped bytes (not yet validated as UTF-8).

Fields

bytes: Mmap

The underlying bytes

validated: RefCell<bool>

Whether the bytes have been validated previously as UTF-8

Implementations

impl InputString

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

Return a view of this InputString as a &str, if it is valid UTF-8.

fn as_str_impl(&self) -> Result<&str, Utf8Error>

Helper for Self::as_str(), with unwrapped error type.

pub(crate) fn load(file: File) -> IoResult<Self>

Try to create an InputString from an open File.

We’ll try to memory-map the file if we can. If that fails, or if we were built without the mmap feature, we’ll fall back to reading the file into memory.

Trait Implementations

impl AsRef<[u8]> for InputString

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for InputString

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

Formats the value using the given formatter.

impl From<InputString> for DocumentText

fn from(s: InputString) -> DocumentText

Converts to this type from the input type.

impl From<String> for InputString

fn from(s: String) -> InputString

Converts to this type from the input type.

impl From<Vec<u8>> for InputString

fn from(bytes: Vec<u8>) -> InputString

Converts to this type from the input type.