MustInt returns the int value of a flag given by name. It panics if an error occurs.

RequestTraceAttrs returns trace attributes for an HTTP request received by a server. The server must be the primary server name if it is known. For e

ValidateFacturXCompat enforces the Factur-X pairing and PDF/A-3 rules. It returns a 400 error when the request is half-specified, or when an explicit

Warn logs a message at the warning level using the wrapped slog.Logger.

detachAsyncContext detaches ctx from the inbound request lifecycle so the webhook goroutine survives echo recycling the request, while preserving the

isClientCancellation reports whether err originates from the client (for example Chromium) closing the connection or letting the request deadline pass

mustMandatoryField binds the target interface with a form field. It populates an error if the value is empty or the "key" does not exist. Currently, o

onResponseReceived records the response origin and remembers the URL for the request id, so a later loading-finished event can attribute its bytes.

EmbedFilesStub embeds files into PDF files.

EncryptPdfStub adds password protection and permission restrictions to PDF files. It does nothing when no password is provided.

FormDataPdfSplitMode creates a [gotenberg.SplitMode] from the form data.

MandatoryPath binds the absolute path of a form data file to a string variable. It populates an error if the file does not exist. var path string

Module returns a module which satisfies the requested interface. func (m *YourModule) Provision(ctx *gotenberg.Context) error { mod, _ := ctx.Modu

NewContext creates a [Context]. In a module, prefer the [Provisioner] interface to get a [Context].

NewFileSystem initializes a new [FileSystem] instance with a unique working directory.

RotateStub rotates pages of PDF files. If angle is 0, it does nothing.

SpanErrorType records errorType as the semconv error.type attribute on span. It is a no-op when errorType is empty.

StampStub applies a stamp to a list of PDF files. If the stamp has no source, it does nothing.

WatermarkStub applies a watermark to a list of PDF files. If the stamp has no source, it does nothing.

WriteMetadataStub writes the metadata into PDF files. If no metadata, it does nothing.

parsePdfObjects parses QPDF JSON v2 output and returns the objects map.

patchFilespecMetadata walks QPDF objects to find Filespecs matching the metadata keys. It sets /AFRelationship and /Subtype on matching objects and re

setStreamSubtype finds a stream object by reference and sets the /Subtype key in its dict.

Debug returns the debug data.

DirPath returns the path to the request's working directory.

FlattenStub merges annotation appearances with page content for each given PDF, effectively deleting the original annotations.

Kill kills the unix process and all its children without creating orphans. See https://medium.com/@felixge/killing-a-child-process-and-all-of-its-chi

Merge combines multiple PDFs into a single PDF. The resulting page order is determined by the order of files provided in inputPaths.

Meter returns a [metric.Meter] with the instrumentation name and version already set.

MustDeprecatedBool returns the boolean value of a deprecated flag if it was explicitly set or the int value of the new flag. It panics if an error occ

MustDeprecatedString returns the string value of a deprecated flag if it was explicitly set or the string value of the new flag. It panics if an error

MustHumanReadableBytes returns the human-readable bytes string of a flag given by name. It panics if an error occurs.

Restricted reports whether at least one permission is denied.

StringEnv retrieves the value of the environment variable named by the key. If the variable is present in the environment and not empty, the value is

ValidatePdfEncryptCompat returns a 400 error when permission restrictions are requested without a password to anchor them.

ValidatePdfFormatsCompat checks for incompatible combinations of PDF formats with other features and returns an appropriate error if found.

buildResource assembles the OpenTelemetry resource shared by the tracer, meter, and logger providers. Detection is best-effort: a detector or merge fa

conversionInputAttrs derives low-cardinality input attributes for a conversion span: the number of received files (when ctx is an [api.Context]) and t

hardTimeoutMiddleware manages hard timeout scenarios, i.e., when a route handler fails to timeout as expected.

onLoadingFinished records a successfully completed request and its size, tracking the single heaviest resource.

patchCatalogAF ensures the Catalog /AF array references all filespec objects.

sanitizeFilename strips path separators (including backslashes, which [filepath.Base] ignores on Linux) and control characters from a caller-supplied

xmlEscape escapes a string for safe inclusion in XML character data.

BuildOutputFile builds the output file according to the output paths registered in the context. If many output paths, an archive is created.

CapAttr truncates s to at most [maxAttrRunes] runes, appending an ellipsis when it shortens the value. It is multibyte-safe.

ClassifyError maps err to a bounded, engine-agnostic error.type value. It recognizes the failure modes shared by every engine: deadline, cancellation,

Content binds the content of a form data file to a string variable. var content string ctx.FormData().Content("foo.txt", &content, "bar")

CreateSubDirectory creates a subdirectory within the context's working directory.

DefaultOptions returns the default values for Options.

DialPinned dials each addr in turn until one connects, returning the first successful connection or the last error. Callers pass the Pinned slice from

EmbedFiles embeds files into a PDF. All files are embedded as file attachments without modifying the main PDF content. TODO: attachments instead? Rena

FileCount returns the number of files received in the request.

FormDataChromiumPdfOptions creates [PdfOptions] from the form data. Fallback to the default value if the considered key is not present.

FormDataChromiumScreenshotOptions creates [ScreenshotOptions] from the form data. Fallback to the default value if the considered key is not present.

GarbageCollect scans the root path and deletes files or directories with names containing specific substrings and before a given expiration time.

GeneratePathFromFilename generates a path within the context's working directory. It uses a UUID-based name on disk to avoid filesystem NAME_MAX limit

Launch starts the managed [Process].

Logger returns the global logger.

MandatoryString binds a form field to a string variable. It populates an error if the value is empty or the "key" does not exist. var foo string c

MustDeprecatedRegexpSlice returns the slice of compiled regular expressions of a deprecated flag if it was explicitly set or the slice of the new flag

MustFloat64 returns the float value of a flag given by name. It panics if an error occurs.

MustRegexp returns the regular expression of a flag given by name. It panics if an error occurs.

NewDirPath generates a new unique path for a directory inside the working directory.

NewOutboundHttpClient returns an [http.Client] that validates every outbound request URL via the same logic as [FilterOutboundURL] and pins the result

OutputFilename returns the filename based on the given output path or the "Gotenberg-Output-Filename" header's value.

ParseError parses an error and returns the corresponding HTTP status and HTTP message.

ReadBookmarks reads the document outline (bookmarks) of a PDF file.

RedactURL parses raw and returns a redacted, length-capped form safe to use as a span attribute or event value. Userinfo, query, and fragment are drop

ResolveAndCheckPublic resolves host and rejects any resolved address that fails [IsPublicIP] with [ErrNonPublicIP]. It is the strict equivalent of [De

ResponseTraceAttrs returns trace attributes for telemetry from an HTTP response. If any of the fields in the ResponseTelemetry are not set the attrib

Route returns the attribute for the route.

SplitPdfStub splits a list of PDF files based on [gotenberg.SplitMode]. It returns a list of output paths or the list of provided input paths if no sp

Stamp applies a stamp (on top of page content) to a PDF file.

Start initiates the process and returns an error if the process cannot be started.

Stop terminates the process and returns an error if the process cannot be stopped.

Watermark applies a watermark (behind page content) to a PDF file.

WriteBookmarks adds a document outline (bookmarks) to a PDF file. The bookmarks parameter represents the hierarchical tree of the outline.

chromiumErrorType maps a conversion error to chromium's bounded reason value, reused as the span error.type. queueReason preserves the historical, rou