Struct Utf8Builder 

pub struct Utf8Builder { /* private fields */ }

A builder for building and validating UTF-8 data from chunks.

Implementations

impl Utf8Builder

pub const fn new() -> Self

Constructs a new, empty Utf8Builder.

pub fn with_capacity(capacity: usize) -> Self

Constructs a new, empty Utf8Builder with a specific capacity.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the given Utf8Builder.

pub fn clear(&mut self)

Clears the builder, removing all data but keeping the allocated capacity.

pub fn len(&self) -> usize

Returns the number of bytes in the buffer, including the bytes of the pending incomplete character.

pub fn is_empty(&self) -> bool

Returns true if the builder contains no data.

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

Returns the current data as a byte slice, including the bytes of the pending incomplete character.

impl Utf8Builder

pub const fn is_valid(&self) -> bool

Returns true if there is no pending incomplete character.

Invalid bytes are never stored, so the data in the buffer is always valid UTF-8 when this returns true.

pub fn finalize(self) -> Result<String, Utf8Error>

Consumes the builder and returns the built String.

Returns an error if the data ends with an incomplete character. The data is dropped in that case, so use into_bytes instead if the raw data is still needed.

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

Consumes the builder and returns the raw data, even if it ends with an incomplete character.

impl Utf8Builder

pub fn push(&mut self, b: u8) -> Result<(), Utf8Error>

Pushes a byte.

Returns an error if the byte is not allowed at the current position. Nothing is stored in that case, so a correct byte can still be pushed afterwards.

pub fn push_str(&mut self, s: &str) -> Result<(), Utf8Error>

Pushes a &str.

Returns an error if there is a pending incomplete character. The builder state is unchanged in that case.

pub fn push_char(&mut self, c: char) -> Result<(), Utf8Error>

Pushes a char.

Returns an error if there is a pending incomplete character. The builder state is unchanged in that case.

pub fn push_chunk(&mut self, chunk: &[u8]) -> Result<(), Utf8Error>

Pushes a chunk.

The chunk does not have to be complete UTF-8 data, because a character can be split across chunks. Returns an error if the chunk contains invalid data. In that case, the leading valid part of the chunk is still stored, so the builder remains usable. However, if the error happens while completing a pending incomplete character, nothing is stored.

Trait Implementations

impl Clone for Utf8Builder

fn clone(&self) -> Utf8Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Utf8Builder

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

Formats the value using the given formatter.

impl Default for Utf8Builder

fn default() -> Utf8Builder

Returns the “default value” for a type.

impl From<&str> for Utf8Builder

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Utf8Builder

fn from(s: String) -> Self

Converts to this type from the input type.

impl Write for Utf8Builder

Writing fails if there is a pending incomplete character.

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.