Skip to main content

QpdfExc

Struct QpdfExc 

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

Structured counterpart of qpdf’s public QPDFExc exception.

qpdf stores the error code, source filename, object description, signed file position, and detail as independent values, while what() is a derived diagnostic string (include/qpdf/QPDFExc.hh:29-77, libqpdf/QPDFExc.cc:3-51). Keep each field as bytes because qpdf’s std::string accepts arbitrary bytes, including embedded NULs.

Self::what_bytes intentionally models the observable C-string returned by std::runtime_error::what(): it ends at the first NUL. The getters retain the complete original fields, so this distinction is not lost. std::fmt::Display is only a lossy UTF-8 projection of those observable bytes and must not be used as a replacement for byte-oriented qpdf logging.

Implementations§

Source§

impl QpdfExc

Source

pub fn new( error_code: QpdfErrorCode, filename: impl AsRef<[u8]>, object: impl AsRef<[u8]>, offset: i64, message: impl AsRef<[u8]>, ) -> Self

Construct a qpdf-shaped exception from its independent raw fields.

Source

pub fn get_error_code(&self) -> QpdfErrorCode

Return qpdf’s independent error code.

Source

pub fn get_filename(&self) -> &[u8] ⓘ

Return the complete original filename bytes.

Source

pub fn get_object(&self) -> &[u8] ⓘ

Return the complete original object-description bytes.

Source

pub fn get_file_position(&self) -> i64

Return qpdf’s signed file position.

Source

pub fn get_message_detail(&self) -> &[u8] ⓘ

Return the complete original detail-message bytes.

Source

pub fn what_bytes(&self) -> &[u8] ⓘ

Return the observable what() bytes, truncated at the first NUL.

Trait Implementations§

Source§

impl Clone for QpdfExc

Source§

fn clone(&self) -> Self

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 Debug for QpdfExc

Source§

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

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

impl Display for QpdfExc

Source§

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

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

impl Eq for QpdfExc

Source§

impl Error for QpdfExc

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<QpdfExc> for Error

Source§

fn from(source: QpdfExc) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for QpdfExc

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for QpdfExc

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.