Struct marked::EncodingHint

pub struct EncodingHint { /* fields omitted */ }

A set of confidence-weighted evidence that a text document is in a particular encoding.

Implementations

impl EncodingHint

pub fn shared_default(enc: &'static Encoding) -> SharedEncodingHint

Construct a new Encoding hint with the specified encoding at DEFAULT_CONF confidence, wrapped for sharing.

pub fn shared_with_hint(
    enc: &'static Encoding,
    confidence: f32
) -> SharedEncodingHint

Construct a new Encoding hint with the specified encoding and confidence, wrapped for sharing.

pub fn add_label_hint<L>(&mut self, enc: L, confidence: f32) -> bool where
    L: AsRef<[u8]>, 

Add a hint for an encoding, by label ASCII-intepreted bytes, and some positive confidence value. If no encoding (or applicable replacement) is found for the specified label, returns false. Return true if an encoding is found and this hint changes the top confidence encoding.

pub fn add_hint(&mut self, enc: &'static Encoding, confidence: f32) -> bool

Add a hint for the specified encoding and some positive confidence value. Return true if this hint changes the top most confident encoding.

pub fn could_read_from(&self, enc: &'static Encoding) -> bool

Return true if the given encoding name could be read with both any current top encoding and from the provided encoding, from the same source bytes.

All supported encoding names are ASCII, so any parsed name encoding hint that would transition from an ASCII-compatible encoding (e.g. Windows-1252, UTF-8) to an ASCII-incompatible encoding (e.g. UTF-16, REPLACEMENT), or vice-versa, or to different ASCII-incompatible encodings (e.g. UTF-16BE to UTF-16LE) is nonsensical and should be ignored.

Note that this check should only be applied to text hints in the document itself, and not applied to hints from Byte-Order-Marks since they aren't ASCII names, or the HTTP Content-Type header since it isn't part of the document body.

pub fn top(&self) -> Option<&'static Encoding>

Return the top (most confident) encoding, if at least one encoding has been hinted.

pub fn confidence(&self) -> f32

Return the summed confidence value for the top (most confident) encoding. Returns 0.0 if no hint has been provided.

pub fn errors(&self) -> u32

Return the total errors accumulated since construction or the last call to clear_errors.

pub fn increment_error(&mut self)

Increment errors count by one.

pub fn changed(&self) -> Option<&'static Encoding>

Return the latest top encoding if the top has changed since construction or the last call to clear_changed.

pub fn clear_changed(&mut self)

Clear changed flag.

pub fn clear_errors(&mut self)

Clear errors count.

Trait Implementations

impl Debug for EncodingHint

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

Formats the value using the given formatter.