Struct std::str::Utf8Error

pub struct Utf8Error { /* fields omitted */ }

Errors which can occur when attempting to interpret a sequence of u8 as a string.

As such, the from_utf8 family of functions and methods for both Strings and &strs make use of this error, for example.

Methods

impl Utf8Error

fn valid_up_to(&self) -> usize

Returns the index in the given string up to which valid UTF-8 was verified.

It is the maximum index such that from_utf8(input[..index]) would return Ok(_).

Examples

Basic usage:

use std::str;

// some invalid bytes, in a vector
let sparkle_heart = vec![0, 159, 146, 150];

// std::str::from_utf8 returns a Utf8Error
let error = str::from_utf8(&sparkle_heart).unwrap_err();

// the second byte is invalid here
assert_eq!(1, error.valid_up_to());

Trait Implementations

impl PartialEq<Utf8Error> for Utf8Error

fn eq(&self, __arg_0: &Utf8Error) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Utf8Error) -> bool

This method tests for !=.

impl Clone for Utf8Error

fn clone(&self) -> Utf8Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Utf8Error

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

Formats the value using the given formatter.

impl Eq for Utf8Error

impl Copy for Utf8Error

impl Debug for Utf8Error

fn fmt(&self, __arg_0: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Error for Utf8Error

fn description(&self) -> &str

A short description of the error.

fn cause(&self) -> Option<&Error>

The lower-level cause of this error, if any.