Skip to main content

WarningCode

Enum WarningCode 

Source
pub enum WarningCode {
    LowConfidenceReadingOrder,
    LowConfidenceTableStructure,
    HiddenTextDetected,
    OffPageTextDetected,
    LowContrastTextDetected,
    AnnotationsPresent,
    ExternalLinksPresent,
    ImageOnlyPage,
    UnsupportedAnnotation,
    PartialParse,
    CapabilityLimited,
}
Expand description

The 11 stable warning codes. Wire format is snake_case.

Variants§

§

LowConfidenceReadingOrder

Reading-order heuristic below confidence threshold.

§

LowConfidenceTableStructure

Table-structure heuristic below confidence threshold.

§

HiddenTextDetected

Hidden text detected (excluded from default chunks).

§

OffPageTextDetected

Text positioned off the page box (excluded from default chunks).

§

LowContrastTextDetected

Low-contrast (e.g. white-on-white) text detected (excluded from default chunks).

§

AnnotationsPresent

Annotations present on a page.

§

ExternalLinksPresent

External links present (never followed).

§

ImageOnlyPage

Page has no extractable text (image-only).

§

UnsupportedAnnotation

Annotation subtype not supported.

§

PartialParse

Parse completed partially (e.g. a page-level failure inside limits).

§

CapabilityLimited

A grounding/verification capability was missing; result downgraded explicitly.

Implementations§

Source§

impl WarningCode

Source

pub const ALL: [WarningCode; 11]

All codes, in contract order.

Source

pub fn as_str(self) -> &'static str

Stable wire string (snake_case), identical to the serde form.

Source

pub fn is_security(self) -> bool

Security-class codes route to security_warnings / the security report; the rest are parser warnings (determinism contract §8).

Source

pub fn is_inventory_backed_security(self) -> bool

Security-report codes that currently require inventory data not present in the canonical document warning lane.

Source

pub fn is_text_backed_security(self) -> bool

Security-report codes backed by text spans and excluded from default chunks.

Source

pub fn is_page_backed_security(self) -> bool

Security-report codes that require a page reference.

Source

pub fn excludes_from_default_chunks(self) -> bool

Warning codes that must never appear in default chunk artifacts.

Source

pub fn security_report_message_template(self) -> Option<&'static str>

Fixed message template for security-report findings.

Trait Implementations§

Source§

impl Clone for WarningCode

Source§

fn clone(&self) -> WarningCode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for WarningCode

Source§

impl Debug for WarningCode

Source§

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

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

impl<'de> Deserialize<'de> for WarningCode

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for WarningCode

Source§

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

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

impl Eq for WarningCode

Source§

impl Hash for WarningCode

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for WarningCode

Source§

fn cmp(&self, other: &WarningCode) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for WarningCode

Source§

fn eq(&self, other: &WarningCode) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for WarningCode

Source§

fn partial_cmp(&self, other: &WarningCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for WarningCode

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for WarningCode

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.