Skip to main content

StreamDataProvider

Trait StreamDataProvider 

Source
pub trait StreamDataProvider {
    // Provided methods
    fn supports_retry(&self) -> bool { ... }
    fn provide_stream_data(
        &self,
        object_ref: ObjectRef,
        pipeline: &mut dyn Pipeline,
    ) -> Result<()> { ... }
    fn provide_stream_data_by_id(
        &self,
        _object_number: u32,
        _generation: u16,
        _pipeline: &mut dyn Pipeline,
    ) -> Result<()> { ... }
    fn provide_stream_data_by_qpdf_obj_gen(
        &self,
        object_number: i64,
        generation: i64,
        pipeline: &mut dyn Pipeline,
    ) -> Result<()> { ... }
    fn provide_stream_data_with_retry(
        &self,
        object_ref: ObjectRef,
        pipeline: &mut dyn Pipeline,
        suppress_warnings: bool,
        will_retry: bool,
    ) -> Result<bool> { ... }
    fn provide_stream_data_with_retry_by_id(
        &self,
        _object_number: u32,
        _generation: u16,
        _pipeline: &mut dyn Pipeline,
        _suppress_warnings: bool,
        _will_retry: bool,
    ) -> Result<bool> { ... }
    fn provide_stream_data_with_retry_by_qpdf_obj_gen(
        &self,
        object_number: i64,
        generation: i64,
        pipeline: &mut dyn Pipeline,
        suppress_warnings: bool,
        will_retry: bool,
    ) -> Result<bool> { ... }
}
Expand description

Deferred stream-data source corresponding to qpdf’s QPDFObjectHandle::StreamDataProvider (include/qpdf/QPDFObjectHandle.hh:68-127).

Registration retains this trait object and does not invoke it. The source is called only when the stream is piped, and every invocation for one stream must produce the same bytes. Providers must not mutate PDF objects while producing data because qpdf may invoke them more than once during a linearized write.

Rust uses distinct method names for qpdf’s overloaded forms. The ObjectRef methods delegate to the numeric identity methods by default, matching qpdf’s QPDFObjGen overload delegation. A provider that supports the retry-aware form must return true from Self::supports_retry.

Provided Methods§

Source

fn supports_retry(&self) -> bool

Whether the retry-aware success-returning callback should be used.

Source

fn provide_stream_data( &self, object_ref: ObjectRef, pipeline: &mut dyn Pipeline, ) -> Result<()>

Legacy provider form receiving the complete stream identity.

Source

fn provide_stream_data_by_id( &self, _object_number: u32, _generation: u16, _pipeline: &mut dyn Pipeline, ) -> Result<()>

Legacy provider form receiving numeric object identity.

Source

fn provide_stream_data_by_qpdf_obj_gen( &self, object_number: i64, generation: i64, pipeline: &mut dyn Pipeline, ) -> Result<()>

Raw qpdf object/generation form of the provider callback. Existing providers that only implement the narrower numeric form retain their behavior for projectable identities; providers that need the full qpdf range can override this method directly.

Source

fn provide_stream_data_with_retry( &self, object_ref: ObjectRef, pipeline: &mut dyn Pipeline, suppress_warnings: bool, will_retry: bool, ) -> Result<bool>

Retry-aware provider form receiving the complete stream identity.

Source

fn provide_stream_data_with_retry_by_id( &self, _object_number: u32, _generation: u16, _pipeline: &mut dyn Pipeline, _suppress_warnings: bool, _will_retry: bool, ) -> Result<bool>

Retry-aware provider form receiving numeric object identity.

Source

fn provide_stream_data_with_retry_by_qpdf_obj_gen( &self, object_number: i64, generation: i64, pipeline: &mut dyn Pipeline, suppress_warnings: bool, will_retry: bool, ) -> Result<bool>

Retry-aware raw qpdf object/generation form of the provider callback.

Trait Implementations§

Source§

impl Debug for dyn StreamDataProvider

Source§

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

Formats the value using the given formatter. Read more

Dyn Compatibility§

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors§