Skip to main content

StreamingValidator

Struct StreamingValidator 

Source
pub struct StreamingValidator { /* private fields */ }
Expand description

Streaming UTF-8 validator for fragmented text frames.

WebSocket spec §6.2 may split text frames into multiple DATA frames (FIN=0) — the UTF-8 stream may be interrupted in the middle of a multi-byte sequence. This validator maintains a small internal buffer for the codepoint that has been started.

Implementations§

Source§

impl StreamingValidator

Source

pub fn new() -> Self

Constructor.

Source

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

Check a chunk of bytes. Returns Ok(()) if (together with the previous state) everything so far is valid.

§Errors

See Utf8Error.

Source

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

true if the stream ends on a codepoint boundary (no pending byte). A text frame with FIN=1 MUST reach this state — otherwise a truncated error.

§Errors

Utf8Error::Truncated if pending bytes remain.

Trait Implementations§

Source§

impl Debug for StreamingValidator

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StreamingValidator

Source§

fn default() -> StreamingValidator

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.