Module: PdfOxide

Defined in:
lib/pdf_oxide.rb,
lib/pdf_oxide.rb,
lib/pdf_oxide/pdf.rb,
lib/pdf_oxide/errors.rb,
lib/pdf_oxide/version.rb,
lib/pdf_oxide/pdf_page.rb,
lib/pdf_oxide/pdf_policy.rb,
lib/pdf_oxide/pdf_signer.rb,
lib/pdf_oxide/ffi/library.rb,
lib/pdf_oxide/ffi/bindings.rb,
lib/pdf_oxide/pdf_document.rb,
lib/pdf_oxide/pdf_validator.rb,
lib/pdf_oxide/auto_extractor.rb,
lib/pdf_oxide/document_editor.rb,
lib/pdf_oxide/markdown_converter.rb,
lib/pdf_oxide/ffi/string_marshaller.rb

Defined Under Namespace

Modules: FFI, MarkdownConverter, PdfPolicy, PdfValidator Classes: ArgumentError, AutoExtractor, ComplianceError, DocumentEditor, EncryptedError, Error, FileNotFoundError, InternalError, InvalidStateError, IoError, ParseError, Pdf, PdfDocument, PdfPage, PdfSigner, PermissionError, RedactionError, SearchError, SignatureError, StateError, UnsupportedFeatureError, UnsupportedPlatformError

Constant Summary collapse

Bindings =

Convenience constants reaching into the FFI sub-module. Keeps downstream callers free of the ‘PdfOxide::FFI::` prefix when accessing the binding layer; matches the Java binding’s flat shape.

FFI::Bindings
StringMarshaller = 
FFI::StringMarshaller
VERSION = 
'0.3.56'

Class Method Summary collapse

Class Method Details

.open(source, password: nil, &block) ⇒ PdfDocument

Open a PDF for reading.

Returns:



51
52
53
 
# File 'lib/pdf_oxide.rb', line 51

def open(source, password: nil, &block)
  PdfDocument.open(source, password: password, &block)
end

.version ⇒ String

Returns library version.

Returns:

  • (String) —

    library version.



56
57
58
 
# File 'lib/pdf_oxide.rb', line 56

def version
  VERSION
end